From d8f030b67ddaee7212b32181c3a20e93e499ec54 Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 8 Apr 2018 18:39:07 +0200 Subject: [PATCH] docs(android-exoplayer): fix typo and jsdocs --- .../plugins/android-exoplayer/index.ts | 77 ++++++++++++------- 1 file changed, 51 insertions(+), 26 deletions(-) diff --git a/src/@ionic-native/plugins/android-exoplayer/index.ts b/src/@ionic-native/plugins/android-exoplayer/index.ts index 26fe4883..bdeb9244 100644 --- a/src/@ionic-native/plugins/android-exoplayer/index.ts +++ b/src/@ionic-native/plugins/android-exoplayer/index.ts @@ -1,5 +1,5 @@ import { Injectable } from '@angular/core'; -import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core'; +import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; import { Observable } from 'rxjs/Observable'; export type AndroidExoPlayerAspectRatio = 'FILL_SCREEN' | 'FIT_SCREEN'; @@ -138,7 +138,7 @@ export interface AndroidExoPlayerControllerConfig { exo_play: string; /** - * Payse button icon. + * Pause button icon. */ exo_pause: string; @@ -184,90 +184,115 @@ export interface AndroidExoPlayerControllerConfig { export class AndroidExoplayer extends IonicNativePlugin { /** * Show the player. - * @param parameters {AndroidExoPlayerParams} Parameters + * @param {AndroidExoPlayerParams} parameters Parameters * @return {Observable} */ - @Cordova({ - observable: true, - clearFunction: 'close', - clearWithArgs: false, - successIndex: 1, - errorIndex: 2 - }) - show(parameters: AndroidExoPlayerParams): Observable { return; } + @Cordova({ + observable: true, + clearFunction: 'close', + clearWithArgs: false, + successIndex: 1, + errorIndex: 2 + }) + show(parameters: AndroidExoPlayerParams): Observable { + return; + } /** * Switch stream without disposing of the player. - * @param url {string} The url of the new stream. - * @param controller {AndroidExoPlayerControllerConfig} Configuration of the controller. + * @param {string} url The url of the new stream. + * @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller. * @return {Promise} */ @Cordova() - setStream(url: string, controller: AndroidExoPlayerControllerConfig): Promise { return; } + setStream( + url: string, + controller: AndroidExoPlayerControllerConfig + ): Promise { + return; + } /** * Will pause if playing and play if paused * @return {Promise} */ @Cordova() - playPause(): Promise { return; } + playPause(): Promise { + return; + } /** * Stop playing. * @return {Promise} */ @Cordova() - stop(): Promise { return; } + stop(): Promise { + return; + } /** * Jump to a particular position. - * @param milliseconds {number} Position in stream in milliseconds + * @param {number} milliseconds Position in stream in milliseconds * @return {Promise} */ @Cordova() - seekTo(milliseconds: number): Promise { return; } + seekTo(milliseconds: number): Promise { + return; + } /** * Jump to a particular time relative to the current position. - * @param milliseconds {number} Time in milliseconds + * @param {number} milliseconds Time in milliseconds * @return {Promise} */ @Cordova() - seekBy(milliseconds: number): Promise { return; } + seekBy(milliseconds: number): Promise { + return; + } /** * Get the current player state. * @return {Promise} */ @Cordova() - getState(): Promise { return; } + getState(): Promise { + return; + } /** * Show the controller. * @return {Promise} */ @Cordova() - showController(): Promise { return; } + showController(): Promise { + return; + } /** * Hide the controller. * @return {Promise} */ @Cordova() - hideController(): Promise { return; } + hideController(): Promise { + return; + } /** * Update the controller configuration. - * @param controller {AndroidExoPlayerControllerConfig} Configuration of the controller. + * @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller. * @return {Promise} */ @Cordova() - setController(controller: AndroidExoPlayerControllerConfig): Promise { return; } + setController(controller: AndroidExoPlayerControllerConfig): Promise { + return; + } /** * Close and dispose of player, call before destroy. * @return {Promise} */ @Cordova() - close(): Promise { return; } + close(): Promise { + return; + } }