获取指定 Converter 的推流状态
更新时间不可用
获取指定 Converter 的推流状态。
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtmp-converters/{converterId}鉴权
regionstringConverter 所在的区域，必须与创建 Converter 时设置的 region 一致。
appIdstring声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。
converterIdstringConverter 的 ID。
Content-Typestringapplication/json
X-Request-IDstringUUID（通用唯一识别码），标识本次请求。推荐你赋值，赋值后，声网服务器会在响应 Header 中返回一个对应的 X-Custom-Request-ID 字段，你可以用此进行问题排查。如果你不赋值，那么声网服务器会自动生成一个 UUID 并在响应 Header 中返回一个对应的 X-Request-ID 字段。
响应
如果状态码为 2XX，请求成功。
Get 请求可获取转码推流和不转码推流的 Converter。
响应 Header
响应 Body
转码推流时返回如下字段。
namestringConverter 的名称。
转码推流的配置。
rtcChannelstring声网频道名称，即 Converter 处理的流所属频道的名称。
Converter 的音频转码配置。
rtcStreamUidsarray<number>指定参与混音的用户 UID。
注意：
- 如果
audioOptions中无该字段，声网将频道内所有用户音频进行混音。 - 如果
audioOptions中存在该字段且值为空，则代表不混合任何用户的音频流。
codecProfilestringConverter 输出的音频编解码规格。支持如下值：
"LC-AAC": MPEG-4 AAC LC。"HE-AAC": High-Efficiency AAC。
sampleRatenumberConverter 输出的音频编码采样率 (Hz)，支持取值如下：
320004410048000
bitratenumberConverter 输出的音频编码码率 (Kbps)。
audioChannelsnumberConverter 输出的音频声道数，支持取值如下：
1：单声道。2：双声道。
参与混音的用户音量。
rtcStreamUidnumber待设置音量的混音用户 UID。
volumenumber指定的混音用户的音量。
Converter 的视频转码配置。
视频画布的配置。
widthnumber画布的宽度 (pixel)。
heightnumber画布的高度 (pixel)。
colornumber画布的背景色。RGB 颜色值，以十进制数表示。如 255 代表蓝色。
layoutTypenumber输出视频的画面布局类型：
0或空：自定义布局，即通过layout自定义布局。1：垂直布局，即通过vertical指定一个用户在屏幕左侧显示大视窗画面，其他用户以小视窗画面在屏幕右侧垂直排列，详见设置垂直布局。垂直布局时，通过Update请求只能更新rtmpUrl。
画布上各用户的视频画面的配置。
注意：仅在 layoutType 为自定义布局时返回 layout 字段。
rtcStreamUidnumber用户 UID。
用户视频画面在画布上的显示区域。超出画布的视频画面会被裁剪。
xPosnumber画面在画布上的 x 坐标 (pixel)。以画布左上角为原点，x 坐标为画面左上角相对于原点的横向位移。
yPosnumber画面在画布上的 y 坐标 (pixel)。以画布左上角为原点，y 坐标为画面左上角相对于原点的纵向位移。
zIndexnumber画面的图层编号。取值范围为 [0,100]。0 代表最下层的图层。100 代表最上层的图层。
widthnumber画面的宽度 (pixel)。
heightnumber画面的高度 (pixel)。
placeholderImageUrlstring用户画面的背景图 URL 地址。支持 JPG、PNG 和 GIF 格式的图片。当频道内用户停止发布视频流，如果设置了该字段，用户的视频画面将切换为该背景图，否则会显示为画布背景色。
alphanumber透明度。0.0 代表完全透明，1.0 代表完全不透明。
画布上视频图片的配置。画布上视频图片可充当水印。
注意：仅在 layoutType 为自定义布局时返回 layout 字段。
imageUrlstring图片的 URL，以 http 或 https 开头。支持 JPG 和 PNG 格式的图片。
图片在画布上的显示区域。超出画布的图片会被裁剪。
xPosnumber图片在画布上的 x 坐标 (pixel)。以画布左上角为原点，x 坐标为图片左上角相对于原点的横向位移。
yPosnumber图片在画布上的 y 坐标 (pixel)。以画布左上角为原点，y 坐标为图片左上角相对于原点的纵向位移。
zIndexnumber图片的图层编号。取值范围为 [0,100]。0 代表最下层的图层。100 代表最上层的图层。
widthnumber图片的宽度 (pixel)。
heightnumber图片的高度 (pixel)。
alphanumber透明度。0.0 代表完全透明，1.0 代表完全不透明。
垂直布局的画面配置。
注意：仅在 layoutType 为垂直布局时返回 vertical 字段。
maxResolutionUidnumber显示大视窗画面的用户 UID。
注意：如果未设置，则每次布局画面刷新时将音量最大的用户显示为大视窗画面。为维持大视窗画面稳定，建议你设置该字段。
refreshIntervalSecnumber布局画面刷新的时间间隔，单位为秒。
defaultPlaceholderImageUrlstring默认的用户画面背景图 URL 地址。支持 JPG、PNG 和 GIF 格式的图片。当频道内用户停止发布视频流时，背景图的行为如下：
- 如果设置了该字段，用户的视频画面将切换为该背景图。
- 如果未设置该字段，用户的视频画面先显示为该用户视频最后一帧，布局刷新后显示为画布背景色。
bitratenumber输出视频的编码码率 (Kbps)。
frameRatenumber输出视频的编码帧率 (fps)。
gopnumber输出视频的 GOP。默认值为 framerate 的 2 倍。
codecstring输出视频的编解码规格。不可设置为空。支持如下值：
"H.264""H.265"
codecProfilestring输出视频的编码规格。支持如下值：
"high": High 级别的视频编码规格，一般用于广播及视频碟片存储，高清电视。"baseline": Baseline 级别的视频编码规格，一般用于低阶或需要额外容错的应用，比如视频通话、手机视频等。"main": Main 级别的视频编码规格，一般用于主流消费类电子产品，如 mp4、便携的视频播放器、PSP 和 iPad 等。 注意：如果codec为 H.265，那么该字段默认值且唯一支持取值为"main"。如果codec为 H.264，那么该字段默认值为"high"。
携带的用户 SEI（Supplemental Enhancement Information）信息。
SEI 信息的数据来源。
metadataboolean是否传入 Metadata 类型的 SEI 信息。
true：传入。false：不传入。
datastreamboolean是否传入 Datastream 类型的 SEI 信息。
true：传入。false：不传入。
输出的 SEI 信息。
typenumber输出 SEI 信息的 payload 的 type。
rtmpUrlstringCDN 推流地址。
idleTimeoutstringConverter 处于空闲状态的最大时长（秒）。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 idleTimeout，Converter 自动销毁，推流停止。
jitterBufferSizeMsnumber音频接收端到网络抖动缓冲端的网络延迟 (ms)。旁路推流服务会根据你设置的值，以 100 为单位向上取整。
不转码推流时返回如下字段。
namestringConverter 的名称。
不转码推流配置。
rtcChannelstring声网频道名称，即 Converter 处理的流所属频道的名称。
rtcStreamUidnumber音视频流所属用户的 UID。
rtmpUrlstringCDN 推流地址。
idleTimeoutstringConverter 处于空闲状态的最大时长（秒）。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 idleTimeout，Converter 自动销毁，推流停止。
jitterBufferSizeMsnumber音频接收端到网络抖动缓冲端的网络延迟 (ms)。旁路推流服务会根据你设置的值，以 100 为单位向上取整。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/:region/v1/projects/:appId/rtmp-converters/:converterId" \
--header 'Authorization: Basic <credentials>' \
--header 'Content-Type: <string>' \
--header 'X-Request-ID: <string>'响应示例
{
"converter": {
"name": "Converter 的名称。",
"transcodeOptions": {
"rtcChannel": "声网频道名称，即 Converter 处理的流所属频道的名称。",
"audioOptions": {
"rtcStreamUids": [
0
],
"codecProfile": "LC-AAC",
"sampleRate": 48000,
"bitrate": 0,
"audioChannels": 1,
"volumes": [
{
"rtcStreamUid": 0,
"volume": 0
}
]
},
"videoOptions": {
"canvas": {
"width": 0,
"height": 0,
"color": 0
},
"layoutType": 0,
"layout": [
{
"rtcStreamUid": 0,
"region": {
"xPos": 0,
"yPos": 0,
"zIndex": 0,
"width": 0,
"height": 0
},
"fillMode": "fill",
"placeholderImageUrl": "用户画面的背景图 URL 地址。支持 JPG、PNG 和 GIF 格式的图片。当频道内用户停止发布视频流，如果设置了该字段，用户的视频画面将切换为该背景图，否则会显示为画布背景色。",
"alpha": 1
}
],
"vertical": {
"maxResolutionUid": 0,
"fillMode": "fill",
"refreshIntervalSec": 3
},
"defaultPlaceholderImageUrl": "默认的用户画面背景图 URL 地址。支持 JPG、PNG 和 GIF 格式的图片。当频道内用户停止发布视频流时，背景图的行为如下：\n- 如果设置了该字段，用户的视频画面将切换为该背景图。\n- 如果未设置该字段，用户的视频画面先显示为该用户视频最后一帧，布局刷新后显示为画布背景色。",
"bitrate": 0,
"frameRate": 0,
"gop": 0,
"codec": "H.264",
"codecProfile": "输出视频的编码规格。支持如下值：\n- `\"high\"`: High 级别的视频编码规格，一般用于广播及视频碟片存储，高清电视。\n- `\"baseline\"`: Baseline 级别的视频编码规格，一般用于低阶或需要额外容错的应用，比如视频通话、手机视频等。\n- `\"main\"`: Main 级别的视频编码规格，一般用于主流消费类电子产品，如 mp4、便携的视频播放器、PSP 和 iPad 等。\n**注意**：如果 `codec` 为 H.265，那么该字段默认值且唯一支持取值为 `\"main\"`。如果 `codec` 为 H.264，那么该字段默认值为 `\"high\"`。",
"seiOptions": {
"source": {
"metadata": false,
"datastream": false,
"customized": {
"prefixForAgoraSei": "自定义 SEI 信息的 payload 前缀。长度必须在 32 个字符以内。默认为空。",
"payload": "自定义 SEI 信息的 payload。长度必须在 4096 个字符以内。默认为空。<p>\n自定义 SEI 信息会被转换为[声网 SEI 规范](/zh-CN/reference/faq/quality/sei)的 SEI 信息。此处设置的 payload 会被转换至声网 SEI 规范中定义的 `app_data` 中。"
}
},
"sink": {
"type": 100
}
}
}
},
"rtmpUrl": "CDN 推流地址。",
"idleTimeout": "Converter 处于空闲状态的最大时长（秒）。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 `idleTimeout`，Converter 自动销毁，推流停止。",
"jitterBufferSizeMs": 0
}
}