Start Participant Replication

ivsrealtime_start_participant_replication

R Documentation

Starts replicating a publishing participant from a source stage to a destination stage¶

Description¶

Starts replicating a publishing participant from a source stage to a destination stage.

Usage¶

ivsrealtime_start_participant_replication(sourceStageArn,
  destinationStageArn, participantId, reconnectWindowSeconds, attributes)

Arguments¶

sourceStageArn

[required] ARN of the stage where the participant is publishing.

destinationStageArn

[required] ARN of the stage to which the participant will be replicated.

participantId

[required] Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by create_participant_token or the jti (JWT ID) used to create a self signed token.

reconnectWindowSeconds

If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.

attributes

Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

Value¶

A list with the following syntax:

list(
  accessControlAllowOrigin = "string",
  accessControlExposeHeaders = "string",
  cacheControl = "string",
  contentSecurityPolicy = "string",
  strictTransportSecurity = "string",
  xContentTypeOptions = "string",
  xFrameOptions = "string"
)

Request syntax¶

svc$start_participant_replication(
  sourceStageArn = "string",
  destinationStageArn = "string",
  participantId = "string",
  reconnectWindowSeconds = 123,
  attributes = list(
    "string"
  )
)