mirror of https://github.com/OpenVidu/openvidu.git
43 lines
1.3 KiB
TypeScript
43 lines
1.3 KiB
TypeScript
|
/*
|
||
|
|
* (C) Copyright 2017-2018 OpenVidu (http://openvidu.io/)
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
import { VideoInsertMode } from '../../Enums/VideoInsertMode';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* See [[Session.subscribe]]
|
||
|
|
*/
|
||
|
|
export interface SubscriberProperties {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* How the video element of the subscriber should be inserted in the DOM
|
||
|
|
* @default VideoInsertMode.APPEND
|
||
|
|
*/
|
||
|
|
insertMode?: VideoInsertMode;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether to initially subscribe to the audio track of the stream or not. You can change the audio state later with [[Subscriber.subscribeToAudio]]
|
||
|
|
* @default true
|
||
|
|
*/
|
||
|
|
subscribeToAudio?: boolean;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether to initially subscribe to the video track of the stream or not. You can change the video state later with [[Subscriber.subscribeToVideo]]
|
||
|
|
* @default true
|
||
|
|
*/
|
||
|
|
subscribeToVideo?: boolean;
|
||
|
|
|
||
|
|
}
|