@twilio/voice-sdk/es5/twilio/outputdevicecollection.d.ts

Twilio's JavaScript Voice SDK

/**
 * A smart collection containing a Set of active output devices.
 */
export default class OutputDeviceCollection {
    private _name;
    private _availableDevices;
    private _beforeChange;
    private _isSupported;
    /**
     * The currently active output devices.
     */
    private _activeDevices;
    /**
     * An instance of Logger to use.
     */
    private _log;
    /**
     * @internal
     */
    constructor(_name: string, _availableDevices: Map<string, MediaDeviceInfo>, _beforeChange: (name: string, devices: string[]) => Promise<void>, _isSupported: boolean);
    /**
     * Delete a device from the collection. If no devices remain, the 'default'
     * device will be added as the sole device. If no `default` device exists,
     * the first available device will be used.
     * @param device - The device to delete from the collection
     * @returns whether the device was present before it was deleted
     */
    delete(device: MediaDeviceInfo): boolean;
    /**
     * Get the current set of devices.
     */
    get(): Set<MediaDeviceInfo>;
    /**
     * Replace the current set of devices with a new set of devices.
     * @param deviceIdOrIds - An ID or array of IDs of devices to replace the existing devices with.
     * @returns Rejects if this feature is not supported, any of the supplied IDs are not found,
     * or no IDs are passed.
     */
    set(deviceIdOrIds: string | string[]): Promise<void>;
    /**
     * Test the devices by playing audio through them.
     * @param [soundUrl] - An optional URL. If none is specified, we will
     *   play a default test tone.
     * @returns Resolves with the result of the underlying HTMLAudioElements' play() calls.
     */
    test(soundUrl?: string): Promise<any>;
}