Channel Operations for Organization

Set Dynamic State

Set the dynamic state for a transcoder.

put/v2/{org}/channels/{channel-id}/transcoder-dynamic-state

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}/transcoder-dynamic-state
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

channel-idstring required

Unique channel identifier

Request body

$schemastring uri

A URL to the JSON Schema for this object.

channel_urnstring

The channel's internal id.

dynamic_state_fieldsstring[] nullable

DynamicStateFields specifies the fields to update in the dynamic state. Any fields not specified will be ignored.

external_idstring

The channel's user provided id.

organizationstring

The channel's organization.

Example request

{
  "$schema": "https://api.istreamplanet.com/schemas/SetDynamicStateRequest.json",
  "dynamic_state": {
    "audio_mutes": [
      {
        "audio_channel": "FRONT_LEFT"
      }
    ],
    "graphic_overlays": [
      {
        "resource_id": "channel-logo",
        "x": {
          "anchor": 100,
          "position": 95
        },
        "y": {
          "anchor": 100,
          "position": 95
        }
      }
    ],
    "text_overlays": [
      {
        "background": "#A2A2A2FF",
        "font_color": "#FF0000",
        "font_height": 5,
        "font_resource_id": "my-font",
        "text": "Hello World!",
        "x": {
          "anchor": 100,
          "position": 95
        },
        "y": {
          "anchor": 100,
          "position": 95
        }
      }
    ]
  }
}

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.