Skip to content

Updates a channel's configuration

Description

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

Usage

ivs_update_channel(arn, name, latencyMode, type, authorized,
  recordingConfigurationArn, insecureIngest, preset,
  playbackRestrictionPolicyArn, multitrackInputConfiguration,
  containerFormat, adConfigurationArn)

Arguments

  • arn

    [required] ARN of the channel to be updated.

  • name

    Channel name.

  • latencyMode

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.

  • type

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

  • authorized

    Whether the channel is private (enabled for playback authorization).

  • recordingConfigurationArn

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

  • insecureIngest

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

  • preset

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

  • playbackRestrictionPolicyArn

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

  • multitrackInputConfiguration

    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

  • containerFormat

    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

  • adConfigurationArn

    ARN of the ad configuration associated with the channel.

Value

A list with the following syntax:

list(
  channel = list(
    arn = "string",
    name = "string",
    latencyMode = "NORMAL"|"LOW",
    type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD",
    recordingConfigurationArn = "string",
    ingestEndpoint = "string",
    playbackUrl = "string",
    authorized = TRUE|FALSE,
    tags = list(
      "string"
    ),
    insecureIngest = TRUE|FALSE,
    preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
    srt = list(
      endpoint = "string",
      passphrase = "string"
    ),
    playbackRestrictionPolicyArn = "string",
    multitrackInputConfiguration = list(
      enabled = TRUE|FALSE,
      policy = "ALLOW"|"REQUIRE",
      maximumResolution = "SD"|"HD"|"FULL_HD"
    ),
    containerFormat = "TS"|"FRAGMENTED_MP4",
    adConfigurationArn = "string"
  )
)

Request syntax

svc$update_channel(
  arn = "string",
  name = "string",
  latencyMode = "NORMAL"|"LOW",
  type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD",
  authorized = TRUE|FALSE,
  recordingConfigurationArn = "string",
  insecureIngest = TRUE|FALSE,
  preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
  playbackRestrictionPolicyArn = "string",
  multitrackInputConfiguration = list(
    enabled = TRUE|FALSE,
    policy = "ALLOW"|"REQUIRE",
    maximumResolution = "SD"|"HD"|"FULL_HD"
  ),
  containerFormat = "TS"|"FRAGMENTED_MP4",
  adConfigurationArn = "string"
)