Interface AxpAudioOutputInterface

AxpAudioOutputInterface provides functionality for managing the audio output device that is used by the user (headphones).

interface AxpAudioOutputInterface {
    addOnDevicesAddedCallback(callback: ((mediaInterface: AxpMediaInterface, devices: AxpMediaDevice[]) => void)): void;
    addOnDevicesRemovedCallback(callback: ((mediaInterface: AxpMediaInterface, devices: AxpMediaDevice[]) => void)): void;
    addOnDevicesUnavailableCallback(callback: ((mediaInterface: AxpMediaInterface) => void)): void;
    addOnSelectedDeviceChangedCallback(callback: ((mediaInterface: AxpMediaInterface, device: AxpMediaDevice) => void)): void;
    addOnSelectedDeviceRemovedCallback(callback: ((mediaInterface: AxpMediaInterface, device: AxpMediaDevice) => void)): void;
    getAvailableDevices(): AxpMediaDevice[];
    getSelectedDevice(): AxpMediaDevice;
    hasAvailableDevices(): boolean;
    isMuted(): boolean;
    mute(): void;
    setSelectedDevice(device: AxpMediaDevice): void;
    unmute(): void;
}

Hierarchy (view full)

Methods

addOnDevicesAddedCallback addOnDevicesRemovedCallback addOnDevicesUnavailableCallback addOnSelectedDeviceChangedCallback addOnSelectedDeviceRemovedCallback getAvailableDevices getSelectedDevice hasAvailableDevices isMuted mute setSelectedDevice unmute

Methods

addOnDevicesAddedCallback

addOnDevicesRemovedCallback

addOnDevicesUnavailableCallback

addOnSelectedDeviceChangedCallback

addOnSelectedDeviceRemovedCallback

getAvailableDevices

getSelectedDevice

hasAvailableDevices

isMuted

  • isMuted(): boolean

  • Returns boolean

    True if audio output device is muted; otherwise, false.

mute

  • mute(): void

  • Mutes audio output device

    Returns void

setSelectedDevice

unmute

  • unmute(): void

  • Unmutes audio output device

    Returns void

Settings

On This Page

Methods