Create Stage

ivsrealtime_create_stage

R Documentation

Creates a new stage (and optionally participant tokens)

Description

Creates a new stage (and optionally participant tokens).

Usage

ivsrealtime_create_stage(name, participantTokenConfigurations, tags,
  autoParticipantRecordingConfiguration)

Arguments

name

Optional name that can be specified for the stage being created.

participantTokenConfigurations

Array of participant token configuration objects to attach to the new stage.

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

autoParticipantRecordingConfiguration

Configuration object for individual participant recording, to attach to the new stage.

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"
      )
    ),
    endpoints = list(
      events = "string",
      whip = "string"
    )
  ),
  participantTokens = list(
    list(
      participantId = "string",
      token = "string",
      userId = "string",
      attributes = list(
        "string"
      ),
      duration = 123,
      capabilities = list(
        "PUBLISH"|"SUBSCRIBE"
      ),
      expirationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$create_stage(
  name = "string",
  participantTokenConfigurations = list(
    list(
      duration = 123,
      userId = "string",
      attributes = list(
        "string"
      ),
      capabilities = list(
        "PUBLISH"|"SUBSCRIBE"
      )
    )
  ),
  tags = list(
    "string"
  ),
  autoParticipantRecordingConfiguration = list(
    storageConfigurationArn = "string",
    mediaTypes = list(
      "AUDIO_VIDEO"|"AUDIO_ONLY"
    )
  )
)