native_avsession.h
Overview
The file declares the AVSession definition, which can be used to set metadata, playback state, and other information.
File to include: <multimedia/av_session/native_avsession.h>
Library: libohavsession.so
System capability: SystemCapability.Multimedia.AVSession.Core
Since: 13
Related module: OHAVSession
Summary
Structs
| Name | typedef Keyword | Description |
|---|---|---|
| OH_AVSession | OH_AVSession | Defines a struct for the playback control session object. You can use the OH_AVSession_Create method to create a playback control session object. |
| OH_AVCastController | OH_AVCastController | Defines a struct for the casting controller object. You can use the OH_AVSession_CreateAVCastController method to create a casting controller object. |
Functions
Function Description
OH_AVSessionCallback_OnCommand()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnCommand)(OH_AVSession* session, AVSession_ControlCommand command, void* userData)
Description
Defines a callback for a common playback control command.
Since: 13
OH_AVSessionCallback_OnFastForward()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnFastForward)(OH_AVSession* session, uint32_t seekTime, void* userData)
Description
Defines a callback for the fast-forward operation.
Since: 13
OH_AVSessionCallback_OnRewind()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnRewind)(OH_AVSession* session, uint32_t seekTime, void* userData)
Description
Defines a callback for the rewind operation.
Since: 13
OH_AVSessionCallback_OnSeek()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnSeek)(OH_AVSession* session, uint64_t seekTime, void* userData)
Description
Defines a callback for the seek operation.
Since: 13
OH_AVSessionCallback_OnSetLoopMode()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnSetLoopMode)(OH_AVSession* session, AVSession_LoopMode curLoopMode, void* userData)
Description
Defines a callback for the operation of setting the loop mode.
Since: 13
OH_AVSessionCallback_OnToggleFavorite()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnToggleFavorite)(OH_AVSession* session, const char* assetId, void* userData)
Description
Defines a callback for the operation of favoriting a media asset.
Since: 13
OH_AVSessionCallback_OutputDeviceChange()
typedef AVSessionCallback_Result (*OH_AVSessionCallback_OutputDeviceChange)(OH_AVSession* session, AVSession_ConnectionState state, AVSession_OutputDeviceInfo* outputDeviceInfo)
Description
Defines a callback for the device changes.
Since: 23
OH_AVSession_Create()
AVSession_ErrCode OH_AVSession_Create(AVSession_Type sessionType, const char* sessionTag, const char* bundleName, const char* abilityName, OH_AVSession** avsession)
Description
Creates a session object.
Since: 13
Parameters
| Name | Description |
|---|---|
| AVSession_Type sessionType | Session type. For details about the available options, see AVSession_Type. |
| const char* sessionTag | Pointer to the session tag. |
| const char* bundleName | Pointer to the bundle name. |
| const char* abilityName | Pointer to the ability name. |
| OH_AVSession** avsession | Double pointer to the session object created. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: Internal server error. AV_SESSION_ERR_INVALID_PARAMETER: 1. sessionType is invalid. 2. The sessionTag parameter is nullptr. 3. The bundleName parameter is nullptr. 4. The abilityName parameter is nullptr. 5. The avsession parameter is nullptr. |
OH_AVSession_Destroy()
AVSession_ErrCode OH_AVSession_Destroy(OH_AVSession* avsession)
Description
Destroys a session object.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_Activate()
AVSession_ErrCode OH_AVSession_Activate(OH_AVSession* avsession)
Description
Activates a session.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_Deactivate()
AVSession_ErrCode OH_AVSession_Deactivate(OH_AVSession* avsession)
Description
Deactivates a session.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_GetSessionType()
AVSession_ErrCode OH_AVSession_GetSessionType(OH_AVSession* avsession, AVSession_Type* sessionType)
Description
Obtains the session type.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_Type* sessionType | Pointer to the session type obtained. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The sessionType parameter is nullptr. |
OH_AVSession_GetSessionId()
AVSession_ErrCode OH_AVSession_GetSessionId(OH_AVSession* avsession, const char** sessionId)
Description
Obtains the session ID.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| const char** sessionId | Double pointer to the session ID obtained. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The sessionId parameter is nullptr. |
OH_AVSession_SetAVMetadata()
AVSession_ErrCode OH_AVSession_SetAVMetadata(OH_AVSession* avsession, OH_AVMetadata* avmetadata)
Description
Sets media metadata.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVMetadata* avmetadata | Pointer to the media metadata. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The avmetadata parameter is nullptr. |
OH_AVSession_SetPlaybackState()
AVSession_ErrCode OH_AVSession_SetPlaybackState(OH_AVSession* avsession, AVSession_PlaybackState playbackState)
Description
Sets the playback state.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_PlaybackState playbackState | Playback state. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The playbackState parameter is invalid. |
OH_AVSession_SetPlaybackPosition()
AVSession_ErrCode OH_AVSession_SetPlaybackPosition(OH_AVSession* avsession, AVSession_PlaybackPosition* playbackPosition)
Description
Sets the playback position.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_PlaybackPosition* playbackPosition | Pointer to the playback position. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The playbackPosition parameter is nullptr. |
OH_AVSession_SetFavorite()
AVSession_ErrCode OH_AVSession_SetFavorite(OH_AVSession* avsession, bool favorite)
Description
Favorites or unfavorites the media asset.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| bool favorite | Whether to favorite or unfavorite the media asset. true means to favorite, false otherwise. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_SetLoopMode()
AVSession_ErrCode OH_AVSession_SetLoopMode(OH_AVSession* avsession, AVSession_LoopMode loopMode)
Description
Sets a loop mode.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_LoopMode loopMode | Loop mode. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The loopMode parameter is invalid. |
OH_AVSession_SetRemoteCastEnabled()
AVSession_ErrCode OH_AVSession_SetRemoteCastEnabled(OH_AVSession* avsession, bool enabled)
Description
Requests to enable remote casting.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| bool enabled | Whether to enable remote casting. true to enable, false otherwise. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_CODE_SESSION_NOT_EXIST: The session does not exist. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_RegisterCommandCallback()
AVSession_ErrCode OH_AVSession_RegisterCommandCallback(OH_AVSession* avsession, AVSession_ControlCommand command, OH_AVSessionCallback_OnCommand callback, void* userData)
Description
Registers a callback for a common playback control command.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_ControlCommand command | Playback control command. |
| OH_AVSessionCallback_OnCommand callback | Callback for the control command. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_CODE_COMMAND_INVALID: The playback control command is invalid. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterCommandCallback()
AVSession_ErrCode OH_AVSession_UnregisterCommandCallback(OH_AVSession* avsession, AVSession_ControlCommand command, OH_AVSessionCallback_OnCommand callback)
Description
Unregisters the callback for a common playback control command.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_ControlCommand command | Playback control command. |
| OH_AVSessionCallback_OnCommand callback | Callback for the control command. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_CODE_COMMAND_INVALID: The playback control command is invalid. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterForwardCallback()
AVSession_ErrCode OH_AVSession_RegisterForwardCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnFastForward callback, void* userData)
Description
Registers a callback for the fast-forward operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnFastForward callback | Callback for the fast-forward operation. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterForwardCallback()
AVSession_ErrCode OH_AVSession_UnregisterForwardCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnFastForward callback)
Description
Unregisters the callback for the fast-forward operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnFastForward callback | Callback for the fast-forward operation. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterRewindCallback()
AVSession_ErrCode OH_AVSession_RegisterRewindCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnRewind callback, void* userData)
Description
Registers a callback for the rewind operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnRewind callback | Callback for the rewind operation. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterRewindCallback()
AVSession_ErrCode OH_AVSession_UnregisterRewindCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnRewind callback)
Description
Unregisters the callback for the rewind operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnRewind callback | Callback for the rewind operation. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterSeekCallback()
AVSession_ErrCode OH_AVSession_RegisterSeekCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnSeek callback, void* userData)
Description
Registers a callback for the seek operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnSeek callback | Callback for the seek operation. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterSeekCallback()
AVSession_ErrCode OH_AVSession_UnregisterSeekCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnSeek callback)
Description
Unregisters the callback for the seek operation.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnSeek callback | Callback for the seek operation. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterSetLoopModeCallback()
AVSession_ErrCode OH_AVSession_RegisterSetLoopModeCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnSetLoopMode callback, void* userData)
Description
Registers a callback for the operation of setting the loop mode.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnSetLoopMode callback | Callback for the operation of setting the loop mode. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterSetLoopModeCallback()
AVSession_ErrCode OH_AVSession_UnregisterSetLoopModeCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnSetLoopMode callback)
Description
Unregisters the callback for the operation of setting the loop mode.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnSetLoopMode callback | Callback for the operation of setting the loop mode. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterToggleFavoriteCallback()
AVSession_ErrCode OH_AVSession_RegisterToggleFavoriteCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnToggleFavorite callback, void* userData)
Description
Registers a callback for the operation of favoriting a media asset.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnToggleFavorite callback | Callback for the operation of favoriting a media asset. |
| void* userData | Pointer to the application data passed through the callback functions. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterToggleFavoriteCallback()
AVSession_ErrCode OH_AVSession_UnregisterToggleFavoriteCallback(OH_AVSession* avsession, OH_AVSessionCallback_OnToggleFavorite callback)
Description
Unregisters the callback for the operation of favoriting a media asset.
Since: 13
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OnToggleFavorite callback | Callback for the operation of favoriting a media asset. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_RegisterOutputDeviceChangeCallback()
AVSession_ErrCode OH_AVSession_RegisterOutputDeviceChangeCallback(OH_AVSession* avsession, OH_AVSessionCallback_OutputDeviceChange callback)
Description
Registers a callback for device changes.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OutputDeviceChange callback | Sets a callback for device changes. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_UnregisterOutputDeviceChangeCallback()
AVSession_ErrCode OH_AVSession_UnregisterOutputDeviceChangeCallback(OH_AVSession* avsession, OH_AVSessionCallback_OutputDeviceChange callback)
Description
Unregisters the callback for device changes.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVSessionCallback_OutputDeviceChange callback | Sets a callback for device changes. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The callback parameter is nullptr. |
OH_AVSession_AcquireSession()
AVSession_ErrCode OH_AVSession_AcquireSession(const char* sessionTag, const char* bundleName, const char* abilityName, OH_AVSession** avsession)
Description
Obtains an existing media session object. When the media session object is no longer needed, call OH_AVSession_Destroy to release it.
Since: 23
Parameters
| Name | Description |
|---|---|
| const char* sessionTag | Pointer to the custom session tag set by the application. |
| const char* bundleName | Pointer to the application bundle name. |
| const char* abilityName | Pointer to the application ability name. |
| OH_AVSession** avsession | Double pointer to the OH_AVSession. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_CODE_SESSION_NOT_EXIST: The session does not exist. AV_SESSION_ERR_INVALID_PARAMETER: 1. The sessionTag parameter is invalid. 2. The bundleName parameter is invalid. 3. The abilityName parameter is invalid. 4. The avsession parameter is nullptr. |
OH_AVSession_CreateAVCastController()
AVSession_ErrCode OH_AVSession_CreateAVCastController(OH_AVSession* avsession, OH_AVCastController** avcastcontroller)
Description
Creates a casting controller object. When the casting controller object is no longer needed, call OH_AVCastController_Destroy to release it.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| OH_AVCastController** avcastcontroller | Double pointer to the OH_AVCastController. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_CODE_SESSION_NOT_EXIST: The session does not exist. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The avcastcontroller parameter is nullptr. |
OH_AVSession_StopCasting()
AVSession_ErrCode OH_AVSession_StopCasting(OH_AVSession* avsession)
Description
Stops the current casting and disconnects the device.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_CODE_SESSION_NOT_EXIST: The session does not exist. AV_SESSION_ERR_INVALID_PARAMETER: The avsession parameter is nullptr. |
OH_AVSession_AcquireOutputDevice()
AVSession_ErrCode OH_AVSession_AcquireOutputDevice(OH_AVSession* avsession, AVSession_OutputDeviceInfo** outputDeviceInfo)
Description
Obtains the current output device.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_OutputDeviceInfo** outputDeviceInfo | Double pointer to the AVSession_OutputDeviceInfo. The outputDeviceInfo pointer cannot be released separately. When the outputDeviceInfo is no longer needed, call OH_AVSession_ReleaseOutputDevice to release it. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_SERVICE_EXCEPTION: The session service is abnormal. AV_SESSION_ERR_CODE_SESSION_NOT_EXIST: The session does not exist. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The outputDeviceInfo parameter is nullptr. |
OH_AVSession_ReleaseOutputDevice()
AVSession_ErrCode OH_AVSession_ReleaseOutputDevice(OH_AVSession* avsession, AVSession_OutputDeviceInfo *outputDeviceInfo)
Description
Releases the output device object.
Since: 23
Parameters
| Name | Description |
|---|---|
| OH_AVSession* avsession | Pointer to a session object. |
| AVSession_OutputDeviceInfo *outputDeviceInfo | Pointer to the output device to be released. |
Returns
| Type | Description |
|---|---|
| AVSession_ErrCode | AV_SESSION_ERR_SUCCESS: The function is executed successfully. AV_SESSION_ERR_INVALID_PARAMETER: 1. The avsession parameter is nullptr. 2. The outputDeviceInfo parameter is nullptr. |