Package org.red5.server.api.stream

Interface IClientBroadcastStream

All Superinterfaces:
IBroadcastStream, IClientStream, IStream
All Known Implementing Classes:
ClientBroadcastStream
public interface IClientBroadcastStream extends IClientStream, IBroadcastStream
A broadcast stream that comes from client.
Author:
The Red5 Project, Steven Gong (steven.gong@gmail.com), Paul Gregoire (mondain@gmail.com)

  • Method Details

    • startPublishing

      void startPublishing()
      Notify client that stream is ready for publishing.

    • getStatistics

      IClientBroadcastStreamStatistics getStatistics()
      Return statistics about the stream.
      Returns:
      statistics

    • setParameters

      void setParameters(Map<String,String> params)
      Sets streaming parameters as supplied by the publishing application.
      Parameters:
      params - parameter map

    • getParameters

      Map<String,String> getParameters()
      Returns streaming parameters.
      Returns:
      parameters

    • addAlias

      boolean addAlias(String alias)
      Adds a stream name subscribe-side alias.
      Parameters:
      alias -
      Returns:
      true if added to the aliases, false otherwise

    • hasAlias

      boolean hasAlias()
      Returns whether or not an subscribe-side alias for this stream exists.
      Returns:
      true if an alias has been added and false otherwise

    • getAlias

      String getAlias()
      Returns an subscribe-side alias.
      Returns:
      alias if at least one exists or null when there are none

    • containsAlias

      boolean containsAlias(String alias)
      Returns whether or not a given subscribe-side alias exists.
      Parameters:
      alias -
      Returns:
      true if found and false otherwise

    • getAliases

      Set<String> getAliases()
      Returns all the subscribe-side aliases.
      Returns:
      all aliases for this instance or an empty set

    • setNameAlias

      void setNameAlias(String nameAlias)
      Sets the publish-side alias for the streams name. Subsequent calls will replace an existing alias if already set.
      Parameters:
      nameAlias - alias to set for the streams name or null to clear it

    • getNameAlias

      String getNameAlias()
      Returns the publish-side alias, if configured.
      Returns:
      alias for the streams name or null if not set

    • aliasRegistered

      boolean aliasRegistered(String alias)
      Returns whether or not an alias is in-use / registered already; this includes both publish and subscribe aliases within a server instance.
      Parameters:
      alias - the name to check against publish and subscribe aliases
      Returns:
      true if registered and false otherwise