openvidu/openvidu-browser/src/OpenViduInternal/Interfaces/Public/Device.ts

37 lines
1.1 KiB
TypeScript

/*
* (C) Copyright 2017-2022 OpenVidu (https://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.
*
*/
/**
* See {@link OpenVidu.getDevices}
*/
export interface Device {
/**
* The kind of device
*/
kind: 'videoinput' | 'audioinput';
/**
* Unique ID for the device. Use it on `audioSource` or `videoSource` properties of {@link PublisherProperties}
*/
deviceId: string;
/**
* Description of the device. An empty string if the user hasn't granted permissions to the site to access the device
*/
label: string;
}