Update Channel
ivs_update_channel | R 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.
Usage¶
ivs_update_channel(arn, authorized, containerFormat, insecureIngest,
latencyMode, multitrackInputConfiguration, name,
playbackRestrictionPolicyArn, preset, recordingConfigurationArn, type)
Arguments¶
arn
[required] ARN of the channel to be updated.
authorized
Whether the channel is private (enabled for playback authorization).
containerFormat
Indicates which content-packaging format is used (MPEG-TS or fMP4). If
multitrackInputConfiguration
is specified andenabled
istrue
, thencontainerFormat
is required and must be set toFRAGMENTED_MP4
. Otherwise,containerFormat
may be set toTS
orFRAGMENTED_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. UseLOW
for near-real-time interaction with viewers.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. If this is set to an empty string, playback restriction policy is disabled.
preset
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
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"
)
)
Request syntax¶
svc$update_channel(
arn = "string",
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",
type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD"
)