mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-31 18:49:43 +08:00
feat(streaming-media): add new parameters & docs (#2576)
This commit is contained in:
parent
8e1ca359ab
commit
f62a123a34
@ -1,18 +1,48 @@
|
|||||||
import { Injectable } from '@angular/core';
|
import { Injectable } from '@angular/core';
|
||||||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Object of options to pass into the playVideo method.
|
||||||
|
*/
|
||||||
export interface StreamingVideoOptions {
|
export interface StreamingVideoOptions {
|
||||||
|
/** Executes after success playing audio. */
|
||||||
successCallback?: Function;
|
successCallback?: Function;
|
||||||
|
/** Executes after error playing video. */
|
||||||
errorCallback?: Function;
|
errorCallback?: Function;
|
||||||
|
/** Force one orientation for playing video. */
|
||||||
orientation?: string;
|
orientation?: string;
|
||||||
|
/** Should the video close after it's over. Defaults to true. */
|
||||||
|
shouldAutoClose?: boolean;
|
||||||
|
/** Should the video have controls. Defaults to true. Android only. */
|
||||||
|
controls?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Object of options to pass into the playAudio method.
|
||||||
|
*/
|
||||||
export interface StreamingAudioOptions {
|
export interface StreamingAudioOptions {
|
||||||
|
/** Background color for audio player. */
|
||||||
bgColor?: string;
|
bgColor?: string;
|
||||||
|
/** Background image for audio player. */
|
||||||
bgImage?: string;
|
bgImage?: string;
|
||||||
|
/**
|
||||||
|
* Background image scale for audio player.
|
||||||
|
* Valid values are:
|
||||||
|
* fit
|
||||||
|
* stretch
|
||||||
|
* aspectStretch.
|
||||||
|
*/
|
||||||
bgImageScale?: string;
|
bgImageScale?: string;
|
||||||
|
/** Start audio player in full screen. iOS only. */
|
||||||
initFullscreen?: boolean;
|
initFullscreen?: boolean;
|
||||||
|
/**
|
||||||
|
* Keeps the screen lit and stops it from locking
|
||||||
|
* while audio is playing. Android only.
|
||||||
|
*/
|
||||||
|
keepAwake?: boolean;
|
||||||
|
/** Executes after success playing audio. */
|
||||||
successCallback?: Function;
|
successCallback?: Function;
|
||||||
|
/** Executes after error playing audio. */
|
||||||
errorCallback?: Function;
|
errorCallback?: Function;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -30,7 +60,9 @@ export interface StreamingAudioOptions {
|
|||||||
* let options: StreamingVideoOptions = {
|
* let options: StreamingVideoOptions = {
|
||||||
* successCallback: () => { console.log('Video played') },
|
* successCallback: () => { console.log('Video played') },
|
||||||
* errorCallback: (e) => { console.log('Error streaming') },
|
* errorCallback: (e) => { console.log('Error streaming') },
|
||||||
* orientation: 'landscape'
|
* orientation: 'landscape',
|
||||||
|
* shouldAutoClose: true,
|
||||||
|
* controls: false
|
||||||
* };
|
* };
|
||||||
*
|
*
|
||||||
* this.streamingMedia.playVideo('https://path/to/video/stream', options);
|
* this.streamingMedia.playVideo('https://path/to/video/stream', options);
|
||||||
|
Loading…
Reference in New Issue
Block a user