Type Alias RoomEvents

Type declaration

• publisherJoined:function

  • publisherJoined(publisher): void

  • Event triggered when a new publisher starts publishing to the stream.

    Parameters

    • publisher: Publisher

      The Publisher object that represents the publisher starting publishing to the stream.

    Returns void

    Example

    import { Publisher, Room } from '@millicast/sdk-interactivity';
    
    const room = new Room({
      streamName,
      streamAccountId,
      publisherName,
    });
    
    room.on('publisherJoined', (publisher: Publisher) => {
      console.log(`The publisher ${publisher.name} has joined the stream.`);
      // TODO: Add the video element to the UI
    });
    Copy

• publisherLeft:function

  • publisherLeft(publisher): void

  • Event triggered when a publisher stops publishing to the stream.

    Parameters

    • publisher: Publisher

      Publisher object that represents the publisher that stopped publishing to the stream.

    Returns void

    Example

    import { Publisher, Room } from '@millicast/sdk-interactivity';
    
    const room = new Room({
      streamName,
      streamAccountId,
      publisherName,
    });
    
    room.on('publisherLeft', (publisher: Publisher) => {
      console.log(`The publisher ${publisher.name} has left.`);
      // TODO: Remove the video element from the UI
    });
    Copy

• sourceAdded:function

  • sourceAdded(publisher, source): void

  • Event triggered when a new source is being published to the stream.

    Parameters

    • publisher: Publisher

      The Publisher object that represents the publisher starting publishing a new source to the stream.
    • source: Source

      The Source object that was added to the stream.

    Returns void

    Example

    import { Publisher, Room, Source } from '@millicast/sdk-interactivity';
    
    const room = new Room({
      streamName,
      streamAccountId,
      publisherName,
    });
    
    room.on('sourceAdded', async (publisher: Publisher, source: Source) => {
      console.log(`The publisher ${publisher.name} has started publishing the source ${source.sourceId.sourceName} (${source.sourceId.sourceType}).`);
      // Request to receive the source
      await source.receive();
      // TODO: Add the media stream to the UI
      const stream = source.mediaStream;
    });
    Copy

• sourceRemoved:function

  • sourceRemoved(publisher, sourceId): void

  • Event triggered when a source stopped being published.

    Parameters

    • publisher: Publisher

      The Publisher object that represents the publisher who stopped publishing the source.
    • sourceId: SourceIdentifier

      The SourceIdentifier object that the represent the identifier of the source that stopped being published.

    Returns void

    Example

    import { Publisher, Room, SourceIdentifier } from '@millicast/sdk-interactivity';
    
    const room = new Room({
      streamName,
      streamAccountId,
      publisherName,
    });
    
    room.on('sourceRemoved', (publisher: Publisher, sourceId: SourceIdentifier) => {
      // TODO: Remove the video from the UI
    });
    Copy

• viewercount:function

  • viewercount(count): void

  • Event triggered from time to time to indicate the number of viewers connected to the stream.

    Parameters

    • count: number

      Number of viewers connected to the stream.

    Returns void

    Example

    import { Room } from '@millicast/sdk-interactivity';
    
    const room = new Room({
      streamName,
      streamAccountId,
      publisherName,
    });
    
    room.on('viewercount', (count: number) => {
      console.log(count, 'viewer(s) connected.');
    });
    Copy