interface_sdk-js/api/@ohos.multimedia.avCastPicker.d.ets
cheng 4e8ab9219f add custom parameter for picker
Signed-off-by: cheng <chengcheng14@huawei.com>
2024-04-29 19:45:46 +08:00

133 lines
3.6 KiB
Plaintext

/*
* Copyright (C) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AVSessionKit
*/
import { AVCastPickerState } from './@ohos.multimedia.avCastPickerParam';
import { AVCastPickerStyle } from './@ohos.multimedia.avCastPickerParam';
import { AVCastPickerColorMode } from './@ohos.multimedia.avCastPickerParam';
/**
* A picker view to show availale streaming device list.
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @since 10
*/
/**
* A picker view to show availale streaming device list.
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @atomicservice
* @since 12
*/
@Component
declare struct AVCastPicker {
/**
* Assigns the color of picker component at normal state .
* @type { ? Color | number | string }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @since 11
*/
/**
* Assigns the color of picker component at normal state .
* @type { ? Color | number | string }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
normalColor?: Color | number | string;
/**
* Assigns the color of picker component at active state.
* @type { ? Color | number | string }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @since 11
*/
/**
* Assigns the color of picker component at active state.
* @type { ? Color | number | string }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
activeColor?: Color | number | string;
/**
* Set the picker style.
* @type { ? AVCastPickerStyle }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @atomicservice
* @since 12
*/
@Prop
pickerStyle?: AVCastPickerStyle;
/**
* Set the picker color mode.
* @type { ? AVCastPickerColorMode }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @atomicservice
* @since 12
*/
@Prop
colorMode?: AVCastPickerColorMode;
/**
* Set the session type used by current picker component which can refer to AVSessionType in avSession.
* If not set, default value is 'audio'.
* @type { ? string }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @atomicservice
* @since 12
*/
@Prop
sessionType?: string;
/**
* Set the custom builder for the picker appearance.
* If not set, system will show the default appearance for different device type.
* @type { ? CustomBuilder }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @atomicservice
* @since 12
*/
@Prop
customPicker?: CustomBuilder;
/**
* Picker state change callback.
* @type { ?function }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @since 11
*/
/**
* Picker state change callback.
* @type { ?function }
* @syscap SystemCapability.Multimedia.AVSession.AVCast
* @crossplatform
* @atomicservice
* @since 12
*/
onStateChange?: (state: AVCastPickerState) => void;
}
export default AVCastPicker;