更新云端播放器

更新时间不可用

更新指定云端播放器的可变配置。

PATCH
https://api.sd-rtn.com/{region}/v1/projects/{appId}/cloud-player/players/{playerid}

Update 方法用于更新指定的云端播放器。

声网目前仅支持更新如下字段:

  • audioOptions:更新音频转码配置。请求 Body 中需要传入音量和音频场景字段。
  • audioOptions.volume:仅更新音量,不更新音频场景。请求 Body 中不需要传入音频场景字段。
  • isPause:控制播放的暂停和恢复。
  • streamUrl:更新在线媒体流地址。
  • seekPosition:更新点播文件的播放位置。
  • tempo:播放倍速。

鉴权

Basic Auth

声网输入在线媒体流 RESTful API 仅支持 HTTPS 协议。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

路径参数

regionstring
必填

云端播放器所在的区域,必须与创建云端播放器设置的 region 一致。

appIdstring
必填

声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。

playeridunknown
必填

云端播放器的 ID。

查询参数

sequencenumber
必填

Update 请求的序列号。取值需要大于或等于 0。请确保后一次 Update 请求的序列号大于前一次 Update 请求的序列号。序列号可以确保声网服务器按照你指定的最新配置来更新云端播放器。

推荐用法:声网推荐你在第一次调用 Update 时,将 sequence 填 0。在第二次调用 Update 时,将 sequence 填 1。在第三次调用 Update 时,将 sequence 填 2。依次类推。声网服务器会按照最新 Update 请求(即最大的序列号)更新云端播放器。

请求 Header

X-Request-IDstring

UUID(通用唯一识别码),标识本次请求。传入该字段后,声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值,声网服务器会自动生成一个 UUID 传入。

请求 Body

字段

响应

如果状态码为 2XX,则请求成功。

响应 Header

X-Request-IDstring

UUID(通用唯一识别码),标识本次请求。该值为本次请求 Header 中 X-Request-ID。如果请求出错,请在日志中打印出该值,排查问题。

X-Resource-IDstring

UUID(通用唯一识别码),标识本次请求销毁的云端播放器的 ID。

请求示例

Example Request
curl --request PATCH \
  --url "https://api.sd-rtn.com/:region/v1/projects/:appId/cloud-player/players/:playerid?sequence=0" \
  --header 'Authorization: Basic <credentials>' \
  --header 'X-Request-ID: <string>' \
  -H 'Content-Type: application/json' \
  -d '{
  "player": {
    "audioOptions": {
      "volume": 10
    },
    "isPause": false,
    "streamUrl": "http://example",
    "seekPosition": 40
  }
}'

响应示例

如果状态码为 2XX,则请求成功。