openvidu/openvidu-browser/lib/OpenVidu/Subscriber.d.ts

24 lines
1.1 KiB
TypeScript
Raw Normal View History

import { Stream } from './Stream';
2018-06-01 14:39:38 +02:00
import { StreamManager } from './StreamManager';
2018-04-26 15:33:47 +02:00
import { SubscriberProperties } from '../OpenViduInternal/Interfaces/Public/SubscriberProperties';
/**
* Packs remote media streams. Participants automatically receive them when others publish their streams. Initialized with [[Session.subscribe]] method
*/
2018-06-01 14:39:38 +02:00
export declare class Subscriber extends StreamManager {
2018-04-26 15:33:47 +02:00
private properties;
/**
* @hidden
*/
2018-06-01 14:39:38 +02:00
constructor(stream: Stream, targEl: string | HTMLElement, properties: SubscriberProperties);
2018-04-26 15:33:47 +02:00
/**
* Subscribe or unsubscribe from the audio stream (if available). Calling this method twice in a row passing same value will have no effect
* @param value `true` to subscribe to the audio stream, `false` to unsubscribe from it
*/
subscribeToAudio(value: boolean): Subscriber;
/**
* Subscribe or unsubscribe from the video stream (if available). Calling this method twice in a row passing same value will have no effect
* @param value `true` to subscribe to the video stream, `false` to unsubscribe from it
*/
subscribeToVideo(value: boolean): Subscriber;
}