@4players/odin
Version:
A cross-platform SDK enabling developers to integrate real-time VoIP chat technology into their projects
53 lines (52 loc) • 1.88 kB
TypeScript
import { Backend } from '@4players/odin-common';
import { Media as MediaData } from '@4players/odin-common/api';
import { Room } from '../room';
import { RemotePeer } from '../peer/remote-peer';
export declare class VideoOutput {
#private;
readonly playback: Backend.VideoPlayback;
readonly peer: RemotePeer;
readonly room: Room;
readonly kind = "video-output";
constructor(mediaData: MediaData, playback: Backend.VideoPlayback, peer: RemotePeer, room: Room);
/**
* Indicates whether the process has started.
*
* @return {boolean} True if the process has started, otherwise false.
*/
get isStarted(): boolean;
/**
* Starts the video output process if it is not already started.
* Ensures the method is not re-triggered while in progress.
*
* @return {Promise<void>} A promise that resolves once the video output process is successfully started.
*/
start(): Promise<void>;
get isPaused(): boolean;
resume(): Promise<void>;
pause(): Promise<void>;
/**
* Retrieves the unique identifier (UID) associated with the playback.
*
* @return {string} The UID of the playback.
*/
get uid(): string;
/**
* Retrieves the media ID associated with this instance.
*
* @return {number} The unique identifier of the media.
*/
get mediaId(): number;
/**
* GEt the current MediaStream associated with playback.
*
* @return {MediaStream | undefined} The current MediaStream if available, otherwise undefined.
*/
get mediaStream(): MediaStream | undefined;
/**
* The custom type can be provided by the remote's VideoInput to help understanding its purpose.
*
* @return {string | undefined} The custom type value if available; otherwise, undefined.
*/
get customType(): string | undefined;
}