Get Composition
| ivsrealtime_get_composition | R Documentation |
Get information about the specified Composition resource¶
Description¶
Get information about the specified Composition resource.
Usage¶
Arguments¶
arn[required] ARN of the Composition resource.
Value¶
A list with the following syntax:
list(
composition = list(
arn = "string",
stageArn = "string",
state = "STARTING"|"ACTIVE"|"STOPPING"|"FAILED"|"STOPPED",
layout = list(
grid = list(
featuredParticipantAttribute = "string",
omitStoppedVideo = TRUE|FALSE,
videoAspectRatio = "AUTO"|"VIDEO"|"SQUARE"|"PORTRAIT",
videoFillMode = "FILL"|"COVER"|"CONTAIN",
gridGap = 123
),
pip = list(
featuredParticipantAttribute = "string",
omitStoppedVideo = TRUE|FALSE,
videoFillMode = "FILL"|"COVER"|"CONTAIN",
gridGap = 123,
pipParticipantAttribute = "string",
pipBehavior = "STATIC"|"DYNAMIC",
pipOffset = 123,
pipPosition = "TOP_LEFT"|"TOP_RIGHT"|"BOTTOM_LEFT"|"BOTTOM_RIGHT",
pipWidth = 123,
pipHeight = 123
)
),
destinations = list(
list(
id = "string",
state = "STARTING"|"ACTIVE"|"STOPPING"|"RECONNECTING"|"FAILED"|"STOPPED",
startTime = as.POSIXct(
"2015-01-01"
),
endTime = as.POSIXct(
"2015-01-01"
),
configuration = list(
name = "string",
channel = list(
channelArn = "string",
encoderConfigurationArn = "string"
),
s3 = list(
storageConfigurationArn = "string",
encoderConfigurationArns = list(
"string"
),
recordingConfiguration = list(
format = "HLS"
)
)
),
detail = list(
s3 = list(
recordingPrefix = "string"
)
)
)
),
tags = list(
"string"
),
startTime = as.POSIXct(
"2015-01-01"
),
endTime = as.POSIXct(
"2015-01-01"
)
)
)