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(name, latencyMode, type, authorized,
  recordingConfigurationArn, tags, insecureIngest, preset,
  playbackRestrictionPolicyArn)

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 Tagging Amazon Web Services Resources for more information, 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).

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

Request syntax

svc$create_channel(
  name = "string",
  latencyMode = "NORMAL"|"LOW",
  type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD",
  authorized = TRUE|FALSE,
  recordingConfigurationArn = "string",
  tags = list(
    "string"
  ),
  insecureIngest = TRUE|FALSE,
  preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
  playbackRestrictionPolicyArn = "string"
)