Get Stream Session

ivs_get_stream_session

R Documentation

Gets metadata on a specified stream

Description

Gets metadata on a specified stream.

Usage

ivs_get_stream_session(channelArn, streamId)

Arguments

channelArn

[required] ARN of the channel resource

streamId

Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

Value

A list with the following syntax:

list(
  streamSession = list(
    streamId = "string",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    channel = list(
      arn = "string",
      name = "string",
      latencyMode = "NORMAL"|"LOW",
      type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD",
      recordingConfigurationArn = "string",
      ingestEndpoint = "string",
      playbackUrl = "string",
      authorized = TRUE|FALSE,
      tags = list(
        "string"
      ),
      insecureIngest = TRUE|FALSE,
      preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
      srt = list(
        endpoint = "string",
        passphrase = "string"
      ),
      playbackRestrictionPolicyArn = "string"
    ),
    ingestConfiguration = list(
      video = list(
        avcProfile = "string",
        avcLevel = "string",
        codec = "string",
        encoder = "string",
        targetBitrate = 123,
        targetFramerate = 123,
        videoHeight = 123,
        videoWidth = 123
      ),
      audio = list(
        codec = "string",
        targetBitrate = 123,
        sampleRate = 123,
        channels = 123
      )
    ),
    recordingConfiguration = list(
      arn = "string",
      name = "string",
      destinationConfiguration = list(
        s3 = list(
          bucketName = "string"
        )
      ),
      state = "CREATING"|"CREATE_FAILED"|"ACTIVE",
      tags = list(
        "string"
      ),
      thumbnailConfiguration = list(
        recordingMode = "DISABLED"|"INTERVAL",
        targetIntervalSeconds = 123,
        resolution = "SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION",
        storage = list(
          "SEQUENTIAL"|"LATEST"
        )
      ),
      recordingReconnectWindowSeconds = 123,
      renditionConfiguration = list(
        renditionSelection = "ALL"|"NONE"|"CUSTOM",
        renditions = list(
          "SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION"
        )
      )
    ),
    truncatedEvents = list(
      list(
        name = "string",
        type = "string",
        eventTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax

svc$get_stream_session(
  channelArn = "string",
  streamId = "string"
)