推流配置更新事件
当你调用 Update
成功更新一个 Converter 配置时,消息通知服务器会向你的服务器通知该事件。
eventType
为 2(ConverterUpdatedEvent)
。
-
更新
converter.transcodeOptions.videoOptions.layout
配置,payload
示例如下:JSON{
"converter": {
"id": "4c014467d647bb87b60b719f6fa57686",
"createTs": 1591786766,
"updateTs": 1591786835,
"state": "running",
"transcodeOptions": {
"rtcChannel": "show68",
"videoOptions": {
"layout": [
{
"rtcStreamUid": 201,
"region": {
"xPos": 0,
"yPos": 0,
"zIndex": 1,
"width": 360,
"height": 320
},
"placeholderImageUrl": "http://example.agora.io/host_placeholder.jpg"
},
{
"rtcStreamUid": 202,
"region": {
"xPos": 0,
"yPos": 320,
"zIndex": 1,
"width": 360,
"height": 320
}
},
{
"imageUrl": "http://example.agora.io/watchmark.jpg",
"region": {
"xPos": 0,
"yPos": 0,
"zIndex": 2,
"width": 36,
"height": 64
}
}
],
"codecProfile": "High",
"frameRate": 15,
"bitrate": 400,
"seiOptions": ""
}
}
},
"lts": 1603456600,
"xRequestId": "7bbcc8a4acce48c78b53c5a261a8a564",
"fields": "id,createTs,updateTs,state,transcodeOptions.videoOptions.layout"
}Converter
包含的字段:id
:String 型字段。Converter 的 ID。它是声网服务器生成的一个 UUID(通用唯一识别码),标识一个已创建的 Converter。createTs
: Number 型字段。创建 Converter 时的 Unix 时间戳(秒)。updateTs
: Number 型字段。最近一次更新 Converter 配置时的 Unix 时间戳(秒)。state
: String 型字段。Converter 的运行状态。该事件中会报告"running"
,表示 Converter 正常运行,正在向 CDN 服务器推流。transcodeOptions
: JSON Object 型必填字段。Converter 的转码配置。rtcChannel
: String 型字段。声网频道名称。videoOptions
: JSON Object 型可选字段。Converter 的视频转码配置。layout
: JSON Array 型字段。画布上视频画面的内容描述。支持两种元素:- RtcStreamView 元素。画布上各用户的视频画面。包含如下字段:
rtcStreamUid
: Number 型字段。视频流所属用户的 UID。region
: JSON Object 型字段。用户视频画面在画布上的显示区域。xPos
: Number 型字段。画面在画布上的 x 坐标 (pixel)。以画布左上角为原点,x 坐标为画面左上角相对于原点的横向位移。yPos
: Number 型字段。画面在画布上的 y 坐标 (pixel)。以画布左上角为原点,y 坐标为画面左上角相对于原点的纵向位移。zIndex
: Number 型字段。画面的图层编号。取值范围为 [0,100]。0
代表最下层的图层。100
代表最上层的图层。width
: Number 型字段。画面的宽度 (pixel)。height
: Number 型字段。画面的高度 (pixel)。
placeholderImageUrl
: String 型字段。替代图片的 HTTP(s) URL。
- ImageView 元素。画布上的视频图片,可用于当水印。包含如下字段:
imageUrl
: String 型字段。图片的 HTTP(S) URL。region
: JSON Object 型字段。图片在画布上的显示区域。xPos
: Number 型字段。图片在画布上的 x 坐标 (pixel)。以画布左上角为原点,x 坐标为图片左上角相对于原点的横向位移。yPos
: Number 型字段。图片在画布上的 y 坐标 (pixel)。以画布左上角为原点,y 坐标为图片左上角相对于原点的纵向位移。zIndex
: Number 型字段。图片的图层编号。取值范围为 [0,100]。0
代表最下层的图层。100
代表最上层的图层。width
: Number 型字段。图片的宽度 (pixel)。height
: Number 型字段。图片的高度 (pixel)。
- RtcStreamView 元素。画布上各用户的视频画面。包含如下字段:
codecProfile
: String 型字段。输出视频的编码规格。。frameRate
: Number 型字段。输出视频的编码帧率 (fps)。bitrate
: Number 型字段。输出视频的编码码率 (Kbps)。。seiOptions
: String 型字段。输出视频中携带的用户 SEI 信息。用于向 CDN 发送用户自定义的 SEI 信息。
lts
: Number 型字段,该事件在业务服务器上发生的的 Unix 时间戳 (秒)。xRequestId
: String 型字段,标识本次请求的 UUID(通用唯一识别码)。该值为本次请求 header 中X-Request-ID
。fields
: String 型字段。JSON 编码方式的字段掩码,详见谷歌 protobuf FieldMask 文档。用于指定返回converter
字段的子集。在本示例中,fields
指定了声网服务器返回 converter 字段中的id
,createTs
,updateTs
和state
字段子集。
-
更新
converter.transcodeOptions.audioOptions
参与混音的用户 UID 列表配置,payload
示例如下:JSON{
"converter": {
"id": "4c014467d647bb87b60b719f6fa57686",
"createTs": 1591786766,
"updateTs": 1591786835,
"state": "running",
"transcodeOptions": {
"rtcChannel": "show68",
"audioOptions": {
"rtcStreamUids": [
201,
202
]
}
}
},
"lts": 1603456600,
"xRequestId": "7bbcc8a4acce48c78b53c5a261a8a564",
"fields": "id,createTs,updateTs,state,transcodeOptions.audioOptions.rtcStreamUids"
}Converter
包含的字段:id
:String 型字段。Converter 的 ID。它是声网服务器生成的一个 UUID(通用唯一识别码),标识一个已创建的 Converter。createTs
: Number 型字段。创建 Converter 时的 Unix 时间戳(秒)。updateTs
: Number 型字段。最近一次更新 Converter 配置时的 Unix 时间戳(秒)。state
: String 型字段。Converter 的运行状态。该事件中会报告"running"
,表示 Converter 正常运行,正在向 CDN 服务器推流。transcodeOptions
: JSON Object 型必填字段。Converter 的转码配置。- rtcChannel: String 型字段。声网频道名称。
audioOptions
: JSON Object 型可选字段。Converter 的音频转码配置。rtcStreamUids
: JSON Array 型可选字段。参与混音的用户 UID/Account。
lts
: Number 型字段,该事件在业务服务器上发生的的 Unix 时间戳 (秒)。xRequestId
: String 型字段,标识本次请求的 UUID(通用唯一识别码)。该值为本次请求 header 中X-Request-ID
。fields
: String 型字段。JSON 编码方式的字段掩码,详见谷歌 protobuf FieldMask 文档。用于指定返回converter
字段的子集。在本示例中,fields
指定了声网 服务器返回 converter 字段中的id
,createTs
,updateTs
和state
等字段子集。
-
更新 converter 的其他配置,如
converter.rtmpUrl
:JSON{
"converter": {
"id": "4c014467d647bb87b60b719f6fa57686",
"createTs": 1591786766,
"updateTs": 1591786835,
"state": "running",
"rtmpUrl": "rtmp://example.agora.io/live/show68"
},
"lts": 1603456600,
"xRequestId": "7bbcc8a4acce48c78b53c5a261a8a564",
"fields": "id,createTs,updateTs,state,rtmpUrl"
}Converter
包含的字段:id
:String 型字段。Converter 的 ID。它是声网服务器生成的一个 UUID(通用唯一识别码),标识一个已创建的 Converter。createTs
: Number 型字段。创建 Converter 时的 Unix 时间戳(秒)。updateTs
: Number 型字段。最近一次更新 Converter 配置时的 Unix 时间戳(秒)。state
: String 型字段。Converter 的运行状态。该事件中会报告"running"
,表示 Converter 正常运行,正在向 CDN 服务器推流。rtmpUrl
: String 型必填字段。CDN 推流地址。
lts
: Number 型字段,该事件在业务服务器上发生的的 Unix 时间戳 (秒)。xRequestId
: String 型字段,标识本次请求的 UUID(通用唯一识别码)。该值为本次请求 header 中X-Request-ID
。fields
: String 型字段。JSON 编码方式的字段掩码,详见谷歌 protobuf FieldMask 文档。用于指定返回converter
字段的子集。在本示例中,fields
指定了声网服务器返回 converter 字段中的id
,createTs
,updateTs
和state
等字段子集。