@byomakase/omakase-player
Version:
## Omakase Player - Open source JavaScript framework for building frame accurate video experiences
43 lines (42 loc) • 1.01 kB
TypeScript
import { Api } from './api';
import { OmpAudioTrack } from '../types';
import { AudioRouterApi } from './audio-router-api';
import { AudioPeakProcessorApi } from './audio-peak-processor-api';
import { OmpSidecarAudioState } from '../video/model';
/**
* For Sidecar audio operations
*/
export interface SidecarAudioApi extends Api {
/**
* Sidecar audio track
*/
get audioTrack(): OmpAudioTrack;
/**
* Sidecar audio router
*/
get audioRouter(): AudioRouterApi | undefined;
/**
* Sidecar audio peak processor
*/
get audioPeakProcessor(): AudioPeakProcessorApi | undefined;
/**
* Sidecar audio track active status
*/
get isActive(): boolean;
/**
* Activates track
*/
activate(): void;
/**
* Deactivates track
*/
deactivate(): void;
/**
* @returns Sidecar audio state
*/
getSidecarAudioState(): OmpSidecarAudioState;
/**
* @internal
*/
correctAudioDrift(): void;
}