Package software.amazon.awssdk.services.ivs.model

Interface Stream.Builder

    • Method Detail

      • channelArn

        Stream.Builder channelArn​(String channelArn)

        Channel ARN for the stream.

        Parameters:
        channelArn - Channel ARN for the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • health

        Stream.Builder health​(String health)

        The stream’s health.

        Parameters:
        health - The stream’s health.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamHealth, StreamHealth

      • health

        Stream.Builder health​(StreamHealth health)

        The stream’s health.

        Parameters:
        health - The stream’s health.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamHealth, StreamHealth

      • playbackUrl

        Stream.Builder playbackUrl​(String playbackUrl)

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

        Parameters:
        playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        Stream.Builder startTime​(Instant startTime)

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

        Parameters:
        startTime - Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        Stream.Builder state​(String state)

        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.

        Parameters:
        state - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamState, StreamState

      • state

        Stream.Builder state​(StreamState state)

        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.

        Parameters:
        state - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamState, StreamState

      • streamId

        Stream.Builder streamId​(String streamId)

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

        Parameters:
        streamId - Unique identifier for a live or previously live stream in the specified channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • viewerCount

        Stream.Builder viewerCount​(Long viewerCount)

        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.

        Parameters:
        viewerCount - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.