Skip to content

Get Channel

ivs_get_channel R Documentation

Gets the channel configuration for the specified channel ARN

Description

Gets the channel configuration for the specified channel ARN. See also batch_get_channel.

Usage

ivs_get_channel(arn)

Arguments

arn

[required] ARN of the channel for which the configuration is to be retrieved.

Value

A list with the following syntax:

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

Request syntax

svc$get_channel(
  arn = "string"
)