Get Stream

ivs_get_stream

R Documentation

Gets information about the active (live) stream on a specified channel¶

Description¶

Gets information about the active (live) stream on a specified channel.

Usage¶

ivs_get_stream(channelArn)

Arguments¶

channelArn: [required] Channel ARN for stream to be accessed.

Value¶

A list with the following syntax:

list(
  stream = list(
    channelArn = "string",
    streamId = "string",
    playbackUrl = "string",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    state = "LIVE"|"OFFLINE",
    health = "HEALTHY"|"STARVING"|"UNKNOWN",
    viewerCount = 123
  )
)

Request syntax¶

svc$get_stream(
  channelArn = "string"
)