Skip to content

Create Channel

ivs_create_channel R Documentation

Creates a new channel and an associated stream key to start streaming

Description

Creates a new channel and an associated stream key to start streaming.

Usage

ivs_create_channel(authorized, containerFormat, insecureIngest,
  latencyMode, multitrackInputConfiguration, name,
  playbackRestrictionPolicyArn, preset, recordingConfigurationArn, tags,
  type)

Arguments

authorized

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

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.

insecureIngest

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

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. Default: LOW.

multitrackInputConfiguration

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

name

Channel name.

playbackRestrictionPolicyArn

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

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 ("").

recordingConfigurationArn

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

tags

Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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.

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"
  ),
  streamKey = list(
    arn = "string",
    channelArn = "string",
    tags = list(
      "string"
    ),
    value = "string"
  )
)

Request syntax

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