Package com.amazonaws.ivs.broadcast

Class Stage

java.lang.Object
com.amazonaws.ivs.broadcast.Stage
All Implemented Interfaces:
Releasable
@RequiresApi(api=28) public class Stage extends Object implements Releasable
The main interface for the host application to create a Stage and interact with the created session.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Stage.ConnectionState
    ConnectionState indicates current Stage session state
    static enum 
    Stage.PublishState
    The various potential publish states for a participant
    static interface 
    Stage.Strategy
    The Strategy is the decision engine associated with a Stage.
    static enum 
    Stage.SubscribeState
    The various potential subscribe states for a participant
    static enum 
    Stage.SubscribeType
    SubscribeType is used in Stage.Strategy to indicate whether SDK should subscribe and what media type it should subscribe

  • Constructor Summary

    Constructors
    Constructor
    Description
    Stage(android.content.Context context, String token, Stage.Strategy strategy)
    Create a new Stage.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRenderer(StageRenderer renderer)
    Adds a renderer to the list of renderers that will be notified of updates to the Stage.
    protected void
    finalize()
     
    void
    join()
    Joins the Stage session associated with the token provided during initialization.
    void
    leave()
    Leaves the joined Stage session.
    void
    refreshStrategy()
    Triggers the Stage.Strategy on this instance to refresh its state.
    void
    release()
    Releases the resources associated with this Stage.
    void
    removeRenderer(StageRenderer renderer)
    Removes a renderer from the list of renderers that will be notified of updates to the Stage.
    void
    replaceStrategy(Stage.Strategy strategy)
    Whenever strategy is changed and host application wants SDK to honor the change, this method needs to be called.

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Stage

      public Stage(@NonNull android.content.Context context, @NonNull String token, @NonNull Stage.Strategy strategy)
      Create a new Stage. This is the main interaction point for interacting with the Stage SDK.
      Parameters:
      context - A DisplayContext or ActivityContext. The ApplicationContext may cause issues for applications compiled against newer SDK versions.
      token - A token generated by the IVS control plane that will be used to join the Stage when join() is called.
      strategy - The Stage.Strategy to use for this Stage.

  • Method Details

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • join

      public void join() throws BroadcastException
      Joins the Stage session associated with the token provided during initialization.
      Throws:
      BroadcastException - if this Stage has already called release(), or if the token provided in Stage constructor was invalid or expired.

    • leave

      public void leave()
      Leaves the joined Stage session. If no Stage session is joined, this call is a no-op

    • addRenderer

      public void addRenderer(StageRenderer renderer)
      Adds a renderer to the list of renderers that will be notified of updates to the Stage.
      Parameters:
      renderer - renderer delegate implementation

    • removeRenderer

      public void removeRenderer(StageRenderer renderer)
      Removes a renderer from the list of renderers that will be notified of updates to the Stage.
      Parameters:
      renderer - renderer delegate implementation

    • replaceStrategy

      public void replaceStrategy(Stage.Strategy strategy)
      Whenever strategy is changed and host application wants SDK to honor the change, this method needs to be called.
      Parameters:
      strategy - strategy delegate implementation

    • refreshStrategy

      public void refreshStrategy()
      Triggers the Stage.Strategy on this instance to refresh its state. This is how host applications will make changes to how they are interacting with a Stage.

    • release

      public void release()
      Releases the resources associated with this Stage. After calling this, the Stage will no longer be useable.
      Specified by:
      release in interface Releasable