Skip to contents

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

Source: R/ivs_operations.R
ivs_create_channel.Rd

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

See https://www.paws-r-sdk.com/docs/ivs_create_channel/ for full documentation.

Usage

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

Arguments

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

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). Default: false.

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.

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. Default: "" (empty string, no playback restriction policy is applied).

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.