文档中心 > 启动实时视频流
启动实时视频流

最近更新时间:2022-09-07

1、功能介绍

  • 请求实时视频,获取播放URL;

  • 获取URL后尽快请求播放视频(建议1分钟以内),否则流无人使用,系统会超时自动关闭流,释放流占用的系统资源。

2、请求参数

参数

是否必选

参数类型

描述

ActionString系统指定参数。取值:StartLiveStream

DeviceId

String

设备ID

PlayProtocolString

播放协议,多值用逗号分隔。取值:rtmp,flv,hls,mp4。默认hls

PrivateFlagInteger是否内网地址。取值:0(否),1(是)。默认值为0
TlsFlagInteger是否使用TLS URL,仅对flv,hls,mp4有效,对PrivateFlag为1无效。取值:0:不使用,1:使用。默认1

3、响应参数

参数

是否必选

参数类型

描述

RequestId

String

该条接口请求ID

CodeString错误码 0:表示成功
DataObject返回数据

---DeviceId

String

设备ID

---AppNameString应用名称
---StreamNameString流名称
---RtmpUrl

String

rtmp播放地址(请求参数play_protocol设置rtmp方式)
---HttpFlvUrlStringhttp flv播放地址(请求参数play_protocol设置flv方式)
---HlsUrl

String

hls播放地址(请求参数play_protocol设置了hls)
---Mp4UrlStringmp4播放地址(请求参数play_protocol设置了mp4)

4、请求示例

请求示例:

GET https://api.unicloud.com/univms?

Action=StartLiveStream

&DeviceID=gb763487hfdk8a

&PlayProtocol=flv

&公共请求参数

返回示例:

{
    "Data": {
        "DeviceId": "2c48c26baf6641d793db324def578c29",
        "HttpFlvUrl": "https://c22g1005.ply.univms.unicloudcdn.com.cn:10443/10001/0e71fcb957114755b720440008b0fb45/2c48c26baf6641d793db324def578c29.flv?group_id=0e71fcb957114755b720440008b0fb45"
    },
    "RequestId": "62165ca9-0ee9-44cb-a7dc-aa0c0e07bbf8",
    "Code": "0"    
}

5、状态码

状态码

描述

200

OK

400

Bad Request