Package org.red5.server.api.stream

Interface IClientStream

All Superinterfaces:
IStream
All Known Subinterfaces:
IClientBroadcastStream, IPlaylistSubscriberStream, ISingleItemSubscriberStream, ISubscriberStream
All Known Implementing Classes:
AbstractClientStream, ClientBroadcastStream, PlaylistSubscriberStream, SingleItemSubscriberStream
public interface IClientStream extends IStream
A stream that is bound to a client.
Author:
The Red5 Project, Steven Gong (steven.gong@gmail.com)

  • Field Details

  • Method Details

    • getStreamId

      Number getStreamId()
      Get stream id allocated in a connection.
      Returns:
      the stream id

    • getConnection

      IStreamCapableConnection getConnection()
      Get connection containing the stream.
      Returns:
      the connection object or null if the connection is no longer active

    • setClientBufferDuration

      void setClientBufferDuration(int bufferTime)
      Set the buffer duration for this stream as requested by the client.
      Parameters:
      bufferTime - duration in ms the client wants to buffer

    • getClientBufferDuration

      int getClientBufferDuration()
      Get the buffer duration for this stream as requested by the client.
      Returns:
      bufferTime duration in ms the client wants to buffer

    • setBroadcastStreamPublishName

      void setBroadcastStreamPublishName(String streamName)
      Set the published stream name that this client is consuming.
      Parameters:
      streamName - of stream being consumed

    • getBroadcastStreamPublishName

      String getBroadcastStreamPublishName()
      Returns the published stream name that this client is consuming.
      Returns:
      stream name of stream being consumed