Package io.antmedia.plugin.api

Interface IStreamListener

public interface IStreamListener

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    joinedTheRoom(String roomId, String streamId)
    AMS inform the plugins when a new participant joins to the conference room
    void
    leftTheRoom(String roomId, String streamId)
    AMS inform the plugins when a participant leaves from the conference room
    default void
    streamFinished(Broadcast broadcast)
    AMS inform the plugins when a stream is finished with this method.
    default void
    streamFinished(String streamId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use streamFinished(Broadcast) because Broadcast object may be deleted when this method is called
    default void
    streamStarted(Broadcast broadcast)
    AMS inform the plugins when a stream is started with this method.
    default void
    streamStarted(String streamId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use streamStarted(Broadcast) because Broadcast object may be deleted when this method is called

  • Method Details

    • streamStarted

      @Deprecated(since="3.0", forRemoval=true) default void streamStarted(String streamId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use streamStarted(Broadcast) because Broadcast object may be deleted when this method is called
      AMS inform the plugins when a stream is started with this method.
      Parameters:
      streamId - is the id of the stream

    • streamStarted

      default void streamStarted(Broadcast broadcast)
      AMS inform the plugins when a stream is started with this method.
      Parameters:
      broadcast - is the the broadcast object of the stream

    • streamFinished

      @Deprecated(since="3.0", forRemoval=true) default void streamFinished(String streamId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use streamFinished(Broadcast) because Broadcast object may be deleted when this method is called
      AMS inform the plugins when a stream is finished with this method.
      Parameters:
      streamId - is the id of the stream

    • streamFinished

      default void streamFinished(Broadcast broadcast)
      AMS inform the plugins when a stream is finished with this method.
      Parameters:
      broadcast - is the broadcast object of the stream The default implementation does nothing in order to avoid breaking the existing plugins.

    • joinedTheRoom

      void joinedTheRoom(String roomId, String streamId)
      AMS inform the plugins when a new participant joins to the conference room
      Parameters:
      roomId - is the id of the conference room
      streamId - is the id of new stream

    • leftTheRoom

      void leftTheRoom(String roomId, String streamId)
      AMS inform the plugins when a participant leaves from the conference room
      Parameters:
      rroomId - is the id of the conference room
      streamId - is the id of new stream