ivs_update_channel: Updates a channel's configuration

View source: R/ivs_operations.R

ivs_update_channelR Documentation

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.

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

Usage

ivs_update_channel(
  arn,
  authorized = NULL,
  insecureIngest = NULL,
  latencyMode = NULL,
  name = NULL,
  preset = NULL,
  recordingConfigurationArn = NULL,
  type = NULL
)

Arguments

arn

[required] ARN of the channel to be updated.

authorized

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

insecureIngest

Whether the channel allows insecure RTMP 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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

name

Channel name.

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. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

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.


paws.analytics documentation built on Sept. 11, 2023, 5:06 p.m.