Channels for Organization

Get Channel

Get a channel's configuration

get/v2/{org}/channels/{channel-id}

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}
  • 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

Headers

If-Matchstring[] nullable

Succeeds if the server's resource matches one of the passed values.

If-None-Matchstring[] nullable

Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

If-Modified-Sincestring date-time-http

Succeeds if the server's resource date is more recent than the passed date.

If-Unmodified-Sincestring date-time-http

Succeeds if the server's resource date is older or the same as the passed date.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

createdstring date-time

Date and time the channel was created.

descriptionstring

A human-readable description of the channel.

desired_state'ON' | 'OFF'

Desired running state for a channel.

enable_byoipboolean

Indicates whether the channel's transcoder needs to run in a designated IP range.

idstring

External Channel ID provided at channel creation time

labelsstring[] nullable

Optional labels for a channel. Any included labels must be at least 1 character long, but no greater than 256 characters. The maximum number of labels is 50.

modifiedstring date-time

Date and time the channel was last modified.

namestring

A friendly human-readable name for the channel. This will get displayed in user interfaces.

organizationstring
region'US_WEST' | 'US_EAST'

Region represents the general geolocation for transcoding and stream egress from iStreamPlanet. If no region is provided at channel creation time, then 'US_WEST' is used.

resource_class'DYNAMIC' | 'STATIC'

If the ResourceClass is unspecified the channel will default to run in the 'DYNAMIC' ResourceClass. Note that changing the ResourceClass for a running channel is supported and will be performed with no downtime.

selfstring uri-reference

Self link for the channel.

Example response

{
  "$schema": "https://api.istreamplanet.com/schemas/Channel.json",
  "id": "my-channel",
  "ingest": {
    "slate": {
      "source_loss_url": "https://example.com/slate.ts"
    },
    "source": {
      "id": "s-examplej95ah2qab"
    }
  },
  "name": "My Channel",
  "signaling": {
    "blackout_settings": {
      "default_blackout_slate_url": "https://example.com/blackout.ts",
      "slates": [
        {
          "blackout_slate_url": "https://example.com/blackout.ts"
        }
      ]
    }
  },
  "transcode": {
    "audio_encoders": [
      {
        "ac4": {
          "drc": {
            "flat_panel_tv": "DRC_FILM_STANDARD",
            "home_theatre": "DRC_FILM_STANDARD",
            "portable_headphones": "DRC_FILM_STANDARD",
            "portable_speakers": "DRC_FILM_STANDARD"
          },
          "encoding_mode": "ENCODING_MODE_EMISSION"
        },
        "bit_rate": 128000,
        "channels": 2,
        "eac3": {
          "ddp_joc_complexity_index": 12,
          "ddp_joc_logical_channels": 10,
          "drc_line_mode": "DRC_FILM_STANDARD",
          "drc_rf_mode": "DRC_FILM_STANDARD",
          "surround_phase_shift": "SURROUND_PHASE_SHIFT_ENABLED"
        },
        "id": "aac128",
        "sample_rate": 48000
      }
    ],
    "segmenter": {
      "gop_duration_secs": 2,
      "segment_duration_secs": 6
    },
    "subtitle_encoders": [
      {
        "atsc_captions": {
          "cea608": 1,
          "cta708": 1
        },
        "language": "en",
        "teletext": {
          "language": "swe",
          "magazine": 1,
          "page": 170
        },
        "transcription": {
          "region": {
            "rows": 3,
            "y": 75
          },
          "verbit_order_id": "3b039274-631a-4c92-b450-1fdb801d2767"
        }
      }
    ],
    "thumbnail_encoders": [
      {
        "height": 180,
        "width": 320
      }
    ],
    "video_encoders": [
      {
        "bit_rate": 6000000,
        "frame_rate": "FR_60",
        "height": 1080,
        "id": "1080p60",
        "width": 1920
      }
    ]
  }
}

Changes

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