video
Learn more about using this API here
The sos.video API groups together methods for video playback.
First 5 parameters (uri, x, y, width, height) are unique identifiers for playing the video using play, stop, resume and pause methods.
Methods
onceEnded()
The onceEnded() method returns a promise which is resolved after the specified video ended.
onceEnded(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
onceStop()
The onceEnded() method returns a promise which is resolved after the specified video have been stopped.
onceStop(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
onEnded()
The onEnded() method sets up a listener, which is called whenever a video finished playing successfully.
onEnded(listener: (event: IVideoEvent) => void): void;
onError()
The onError() method sets up a listener, which is called whenever a video failed to finish playing.
onError(listener: (event: IVideoEvent) => void): void;
onPause()
The onPause() method sets up a listener, which is called whenever a video is paused
onPause(listener: (event: IVideoEvent) => void): void;
onPlay()
The onPlay() method sets up a listener, which is called whenever a video starts to play.
onPlay(listener: (event: IVideoEvent) => void): void;
onPrepare()
The onPrepare() method sets up a listener, which is called whenever a video started to be prepared.
onPrepare(listener: (event: IVideoEvent) => void): void;
onResume()
The onResume() method sets up a listener, which is called whenever a video is resumed
onResume(listener: (event: IVideoEvent) => void): void;
onStop()
The onStop() method sets up a listener, which is called whenever a video has been stopped.
onStop(listener: (event: IVideoEvent) => void): void;
pause()
The pause() method pauses the video, playback can be resumed with resume().
pause(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
play()
The play() method starts the playback of a video previously prepared by prepare() method.
play(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
prepare()
The play() method loads the video into memory and prepares it for a playback.
prepare(uri: string, x: number, y: number, width: number, height: number, options?: IOptions): Promise<void>;
Params
| Name | Type | Description |
|---|---|---|
options. | boolean | 4k Support for 4k video (Deprecated since Tizen Core App v2.1.0) |
options.background (optional) | boolean | Bring video behind the applet html (similar to z-index: -1) |
options.volume (optional) | number | Adjust volume of playing video itself (doesn't adjust display speaker volume) |
removeEventListeners()
The removeEventListeners() method removes all listeners set up for all videos.
removeEventListeners(): void;
resume()
The resume() method resumes the video paused by pause().
resume(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
stop()
The stop() method stops the video, it can't be resumed with resume().
stop(uri: string, x: number, y: number, width: number, height: number): Promise<void>;