ivs/aws.sdk.kotlin.services.ivs.model/Stream

Stream

class Stream

Specifies a live video stream that has been ingested and distributed.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val channelArn: String?

Channel ARN for the stream.

Link copied to clipboard
val health: StreamHealth?

The stream’s health.

Link copied to clipboard
val playbackUrl: String?

URL of the master playlist, required by the video player to play the HLS stream.

Link copied to clipboard
val startTime: Instant?

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

Link copied to clipboard
val state: StreamState?

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

Link copied to clipboard
val streamId: String?

Unique identifier for a live or previously live stream in the specified channel.

Link copied to clipboard
val viewerCount: Long

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Functions

Link copied to clipboard
inline fun copy(block: Stream.Builder.() -> Unit = {}): Stream
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String