logo
当前页

更新云端播放器


描述

调用本接口更新指定云端播放器的播放进度、音频转码参数、视频转码参数等信息。

接口原型

  • 请求方法:POST
  • 请求地址:https://cloud-player-api.zego.im/?Action=UpdatePlayer
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数,公共参数列表请参考 调用方式 - 公共请求参数

参数类型是否必选描述
PlayerIdString云端播放器唯一标识 ID,通过 CreatePlayer 返回。调用本接口时,请确保 PlayerId 是已存在的,否则可能会出错。
SequenceNumber请求的序列号,用于保证时序,同个播放器任务的参数修改需要保证序列号的递增。例如:"Sequence":1。ZEGO 服务器将按照最新的配置来更新云端播放器。
StreamUrlString媒体资源的地址,必须是有效的 HTTP/HTTPS 地址,且长度在 1024 字节以内。
BackupStreamUrlString媒体资源的备用地址,必须是有效的 HTTP/HTTPS 地址,且长度在 1024 字节以内。当 StreamUrl 参数中的地址访问失败时,云端播放器会尝试访问备用地址。
VideoOptionsObject视频转码参数配置。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
└WidthNumber视频宽度,取值范围为 [1, 3000],且必须是 2 的整倍数,单位为 px。请注意,Width 和 Height 任意参数设置为 1 时,都表示纯音频推流;该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
└HeightNumber视频高度,取值范围为 [1, 3000],且必须是 2 的整倍数,单位为 px。请注意,Width 和 Height 任意参数设置为 1 时,都表示纯音频推流;该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
└VideoBitrateNumber视频码率,取值范围为 [1, 50000],单位为 kbps。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
AudioOptionsObject音频转码参数配置。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
└AudioBitrateNumber音频码率,范围为 [1, 192],单位为 kbps。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
└VolumeNumber音量值,范围为 [0, 200]。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
SeekToNumber指定播放进度(秒)。请注意,该参数不填写时,默认使用上一次调用本接口、或创建云端播放器时的配置。
IsPauseNumber是否暂停播放。
  • 0:正常播放源文件。
  • 1:暂停播放源文件。
RepeatTimesNumber播放次数。
  • 1:播放媒体流 1 次。
  • -1:自动循环播放。
  • n:自定义播放媒体流次数,必须大于 0。
请注意,该参数不填写或值为 0 时,默认使用上一次调用本接口、或创建云端播放器时的配置。

请求示例

  • 请求 URL
Untitled
https://cloud-player-api.zego.im/?Action=UpdatePlayer
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false
1
Copied!
  • 请求消息体
Untitled
{
    "PlayerId": "player_1",
    "Sequence": 100,
    "StreamUrl": "https://xxx.com/video/test111.mp4",
    "BackupStreamUrl": "",
    "VideoOptions": {
        "Width": 360,
        "Height": 640,
        "VideoBitrate": 1200
    },
    "AudioOptions": {
        "AudioBitrate": 48,
        "Volume": 150
    },
    "SeekTo": 10,
    "IsPause": 1,
    "RepeatTimes": 1
}
1
Copied!

响应参数

参数类型描述
CodeNumber错误码。
MessageString错误描述。
RequestIdString请求 ID。

响应示例

Untitled
{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}
1
Copied!

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码说明处理建议
0成功。-
100000004签名过期。请重新生成签名。
100000005签名错误。请确认生成签名的参数是否正确。
350006001接口请求频率超过上限。请确认对应接口的 QPS 限制,降低请求频率。
350006002网关校验失败。请联系 ZEGO 技术支持处理。
350006003无效的输入参数。请根据 Message 提示,调整对应参数的取值。
350006006服务未开通。请联系 ZEGO 技术支持,开通服务权限。
350010000系统错误。请联系 ZEGO 技术支持处理。

Previous

创建云端播放器

Next

销毁云端播放器