mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
add new picker api
Signed-off-by: ccfriend <chengcheng14@huawei.com>
This commit is contained in:
parent
0b167d8de9
commit
a8d7ed0208
78
api/@ohos.multimedia.avsession.d.ts
vendored
78
api/@ohos.multimedia.avsession.d.ts
vendored
@ -24,6 +24,7 @@ import { KeyEvent } from './@ohos.multimodalInput.keyEvent';
|
||||
import { ElementName } from './bundleManager/ElementName';
|
||||
import image from './@ohos.multimedia.image';
|
||||
import audio from './@ohos.multimedia.audio';
|
||||
import { AVCastPickerState, AVCastPickerColorMode } from './@ohos.multimedia.avCastPickerParam'
|
||||
import type media from './@ohos.multimedia.media';
|
||||
import type Context from './application/BaseContext';
|
||||
|
||||
@ -3578,6 +3579,83 @@ declare namespace avSession {
|
||||
off(type: 'keyRequest', callback?: KeyRequestCallback): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* A helper to enable a picker to select output devices
|
||||
*
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
class AVCastPickerHelper {
|
||||
/**
|
||||
* The constructor used to create a AVCastPickerHelper object.
|
||||
*
|
||||
* @param { Context } context - represents the context.
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
constructor(context: Context);
|
||||
|
||||
/**
|
||||
* Pull up the avcastpicker based on the options.
|
||||
*
|
||||
* @param { AVCastPickerOptions } [options] - represents the options provided to the picker.
|
||||
* @returns { Promise<void> } void promise when executed successfully
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
select(options?: AVCastPickerOptions): Promise<void>;
|
||||
|
||||
/**
|
||||
* Register picker state change callback.
|
||||
* @param { 'pickerStateChange' } type - 'pickerStateChange'
|
||||
* @param { Callback<AVCastPickerState> } callback - The callback used to handle picker state changed event.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
on(type: 'pickerStateChange', callback: Callback<AVCastPickerState>) : void;
|
||||
|
||||
/**
|
||||
* Unregister picker state change callback.
|
||||
* @param { 'pickerStateChange' } type - 'pickerStateChange'
|
||||
* @param { Callback<AVCastPickerState> } callback - The callback used to handle picker state changed event.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
off(type: 'pickerStateChange', callback?: Callback<AVCastPickerState>) : void;
|
||||
}
|
||||
|
||||
/**
|
||||
* An option to make different picker usage
|
||||
*
|
||||
* @typedef AVCastPickerOptions
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
interface AVCastPickerOptions {
|
||||
/**
|
||||
* Indicates current session type to show different picker ui.
|
||||
* If not set, default value is 'audio'.
|
||||
*
|
||||
* @type { ? AVSessionType }
|
||||
* @syscap SystemCapability.Multimedia.AVSession.AVCast
|
||||
* @atomicservice
|
||||
* @since 14
|
||||
*/
|
||||
sessionType?: AVSessionType;
|
||||
}
|
||||
|
||||
/**
|
||||
* The callback of key request.
|
||||
*
|
||||
|
Loading…
Reference in New Issue
Block a user