Skip to content

Updates a stage’s configuration

Description

Updates a stage’s configuration.

Usage

ivsrealtime_update_stage(arn, name,
  autoParticipantRecordingConfiguration)

Arguments

  • arn

    [required] ARN of the stage to be updated.

  • name

    Name of the stage to be updated.

  • autoParticipantRecordingConfiguration

    Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

Value

A list with the following syntax:

list(
  stage = list(
    arn = "string",
    name = "string",
    activeSessionId = "string",
    tags = list(
      "string"
    ),
    autoParticipantRecordingConfiguration = list(
      storageConfigurationArn = "string",
      mediaTypes = list(
        "AUDIO_VIDEO"|"AUDIO_ONLY"|"NONE"
      ),
      thumbnailConfiguration = list(
        targetIntervalSeconds = 123,
        storage = list(
          "SEQUENTIAL"|"LATEST"
        ),
        recordingMode = "INTERVAL"|"DISABLED"
      ),
      recordingReconnectWindowSeconds = 123,
      hlsConfiguration = list(
        targetSegmentDurationSeconds = 123
      ),
      recordParticipantReplicas = TRUE|FALSE
    ),
    endpoints = list(
      events = "string",
      whip = "string",
      rtmp = "string",
      rtmps = "string"
    )
  )
)

Request syntax

svc$update_stage(
  arn = "string",
  name = "string",
  autoParticipantRecordingConfiguration = list(
    storageConfigurationArn = "string",
    mediaTypes = list(
      "AUDIO_VIDEO"|"AUDIO_ONLY"|"NONE"
    ),
    thumbnailConfiguration = list(
      targetIntervalSeconds = 123,
      storage = list(
        "SEQUENTIAL"|"LATEST"
      ),
      recordingMode = "INTERVAL"|"DISABLED"
    ),
    recordingReconnectWindowSeconds = 123,
    hlsConfiguration = list(
      targetSegmentDurationSeconds = 123
    ),
    recordParticipantReplicas = TRUE|FALSE
  )
)