stream

The sos.video API groups together methods for streaming videos.

warning

Are you using Samsung Tizen to play streams? Read more about limitation and Tizen-specific details.

danger

Be aware version of JS API (v6.0.0+) changed how stream functions play() and prepare() work. For using an options object you need to our latest core app versions. If you are using older core app versions, you need to use deprecated format.

Methods

getTracks()

The getTracks() method returns a track list of a stream.

getTracks(videoId: IVideoProperties): Promise<ITrackInfo[]>;

onConnected()

The onConnected() method sets up a listener, which is called whenever a stream is connected.

onConnected(listener: (event: IStreamEvent<'connected'>) => void): void;

onDisconnected()

The onDisconnected() method sets up a listener, which is called whenever a stream gets disconnected.

onDisconnected(listener: (event: IStreamEvent<'disconnected'>) => void): void;

onError()

The onTracksChanged() method sets up a listener, which is called whenever an unexpected error occurs during a stream.

onError(listener: (event: IStreamErrorEvent) => void): void;

onPause()

The onStop() method sets up a listener, which is called whenever a stream is paused.

onPause(listener: (event: IStreamEvent<'pause'>) => void): void;

onPlay()

The onPlay() method sets up a listener, which is called whenever a stream starts playing.

onPlay(listener: (event: IStreamEvent<'play'>) => void): void;

onPrepare()

The onPrepare() method sets up a listener, which is called whenever a stream gets prepared.

onPrepare(listener: (event: IStreamEvent<'prepare'>) => void): void;

onResume()

The onStop() method sets up a listener, which is called whenever a stream is resumed.

onResume(listener: (event: IStreamEvent<'resume'>) => void): void;

onStop()

The onStop() method sets up a listener, which is called whenever a stream stops.

onStop(listener: (event: IStreamEvent<'stop'>) => void): void;

onTracksChanged()

The onTracksChanged() method sets up a listener, which is called whenever a track is changed.

onTracksChanged(listener: (event: IStreamTracksChangedEvent) => void): void;

pause()

The pause() method pauses the stream, it can be resumed with resume().

pause(uri: string, x: number, y: number, width: number, height: number): Promise<void>;

play()

The play() method starts the streaming of a streaming previously prepared by prepare() method.

play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;

prepare()

The prepare() method prepares the stream in the background.

info

If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.

prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamPrepareOptions | keyof typeof StreamProtocol): Promise<void>;

GitHub Example

removeEventListeners()

The removeEventListeners() removes all listeners set up on sos.stream.

removeEventListeners(): void;

resetTrack()

The resetTrack() method resets a track of a stream.

resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;

resume()

The resume() method resumes the stream paused by pause().

resume(uri: string, x: number, y: number, width: number, height: number): Promise<void>;

selectTrack()

The selectTrack() method selects a track of a stream.

selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;

stop()

The stop() method stops the stream, it can't be resumed with resume().

stop(uri: string, x: number, y: number, width: number, height: number): Promise<void>;