com.amazonaws.services.ivs.model

Class Stream

java.lang.Object

com.amazonaws.services.ivs.model.Stream

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Stream
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Stream()

Method Summary

Modifier and Type	Method and Description
Stream	clone()
boolean	equals(Object obj)
String	getChannelArn() Channel ARN for the stream.
String	getHealth() The stream’s health.
String	getPlaybackUrl() URL of the master playlist, required by the video player to play the HLS stream.
Date	getStartTime() Time of the stream’s start.
String	getState() The stream’s state.
String	getStreamId() Unique identifier for a live or previously live stream in the specified channel.
Long	getViewerCount() A count of concurrent views of the stream.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setChannelArn(String channelArn) Channel ARN for the stream.
void	setHealth(String health) The stream’s health.
void	setPlaybackUrl(String playbackUrl) URL of the master playlist, required by the video player to play the HLS stream.
void	setStartTime(Date startTime) Time of the stream’s start.
void	setState(String state) The stream’s state.
void	setStreamId(String streamId) Unique identifier for a live or previously live stream in the specified channel.
void	setViewerCount(Long viewerCount) A count of concurrent views of the stream.
String	toString() Returns a string representation of this object.
Stream	withChannelArn(String channelArn) Channel ARN for the stream.
Stream	withHealth(StreamHealth health) The stream’s health.
Stream	withHealth(String health) The stream’s health.
Stream	withPlaybackUrl(String playbackUrl) URL of the master playlist, required by the video player to play the HLS stream.
Stream	withStartTime(Date startTime) Time of the stream’s start.
Stream	withState(StreamState state) The stream’s state.
Stream	withState(String state) The stream’s state.
Stream	withStreamId(String streamId) Unique identifier for a live or previously live stream in the specified channel.
Stream	withViewerCount(Long viewerCount) A count of concurrent views of the stream.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Stream

public Stream()

Method Detail

setChannelArn

public void setChannelArn(String channelArn)

Channel ARN for the stream.

Parameters:

channelArn - Channel ARN for the stream.

getChannelArn

public String getChannelArn()

Channel ARN for the stream.

Returns:

Channel ARN for the stream.

withChannelArn

public Stream withChannelArn(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.

setHealth

public void setHealth(String health)

The stream’s health.

Parameters:

health - The stream’s health.

See Also:

StreamHealth

getHealth

public String getHealth()

The stream’s health.

Returns:

The stream’s health.

See Also:

StreamHealth

withHealth

public Stream withHealth(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

withHealth

public Stream withHealth(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

setPlaybackUrl

public void setPlaybackUrl(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.

getPlaybackUrl

public String getPlaybackUrl()

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

Returns:

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

withPlaybackUrl

public Stream withPlaybackUrl(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.

setStartTime

public void setStartTime(Date 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.

getStartTime

public Date getStartTime()

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

Returns:

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

withStartTime

public Stream withStartTime(Date 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.

setState

public void setState(String state)

The stream’s state.

Parameters:

state - The stream’s state.

See Also:

StreamState

getState

public String getState()

The stream’s state.

Returns:

The stream’s state.

See Also:

StreamState

withState

public Stream withState(String state)

The stream’s state.

Parameters:

state - The stream’s state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StreamState

withState

public Stream withState(StreamState state)

The stream’s state.

Parameters:

state - The stream’s state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StreamState

setStreamId

public void setStreamId(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.

getStreamId

public String getStreamId()

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

Returns:

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

withStreamId

public Stream withStreamId(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.

setViewerCount

public void setViewerCount(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.

getViewerCount

public Long getViewerCount()

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:

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.

withViewerCount

public Stream withViewerCount(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Stream clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo