RDK Documentation (Open Sourced RDK Components)
StreamOut Interface

Description

This file defines bluetooth manager's data streaming interfaces to external Bluetooth devices.

Macros

#define BTRMGR_SO_MAX_VOLUME   255
 
#define BTRMGR_AUDIO_SFMT_SIGNED_8BIT   "S8"
 
#define BTRMGR_AUDIO_SFMT_SIGNED_LE_16BIT   "S16LE"
 
#define BTRMGR_AUDIO_SFMT_SIGNED_LE_24BIT   "S24LE"
 
#define BTRMGR_AUDIO_SFMT_SIGNED_LE_32BIT   "S32LE"
 
#define BTRMGR_AUDIO_CHANNELMODE_MONO   "mono"
 
#define BTRMGR_AUDIO_CHANNELMODE_DUAL   "dual"
 
#define BTRMGR_AUDIO_CHANNELMODE_STEREO   "stereo"
 
#define BTRMGR_AUDIO_CHANNELMODE_JSTEREO   "joint"
 

Typedefs

typedef eBTRMgrRet(* fPtr_BTRMgr_SO_StatusCb) (stBTRMgrMediaStatus *apstBtrMgrSoStatus, void *apvUserData)
 
typedef void * tBTRMgrSoGstHdl
 
typedef enum _eBTRMgrSOGstRet eBTRMgrSOGstRet
 
typedef enum _eBTRMgrSOGstStatus eBTRMgrSOGstStatus
 
typedef eBTRMgrSOGstRet(* fPtr_BTRMgr_SO_GstStatusCb) (eBTRMgrSOGstStatus aeBtrMgrSoGstStatus, void *apvUserData)
 

Enumerations

enum  _eBTRMgrSOGstRet
 
enum  _eBTRMgrSOGstStatus
 

Functions

eBTRMgrRet BTRMgr_SO_Init (tBTRMgrSoHdl *phBTRMgrSoHdl, fPtr_BTRMgr_SO_StatusCb afpcBSoStatus, void *apvUserData)
 This API invokes BTRMgr_SO_GstInit() and also set the state as initialized. More...
 
eBTRMgrRet BTRMgr_SO_DeInit (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API invokes BTRMgr_SO_GstDeInit() for the deinitializations. More...
 
eBTRMgrRet BTRMgr_SO_GetDefaultSettings (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API is used to load the default settings used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_GetCurrentSettings (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API will fetch the current settings used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_GetStatus (tBTRMgrSoHdl hBTRMgrSoHdl, stBTRMgrMediaStatus *apstBtrMgrSoStatus)
 This API fetches the media file status. More...
 
eBTRMgrRet BTRMgr_SO_SetStatus (tBTRMgrSoHdl hBTRMgrSoHdl, stBTRMgrMediaStatus *apstBtrMgrSoStatus)
 This API will set the current settings used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_SetVolume (tBTRMgrSoHdl hBTRMgrSoHdl, unsigned char ui8Volume)
 This API will set the current volume used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_GetVolume (tBTRMgrSoHdl hBTRMgrSoHdl, unsigned char *ui8Volume)
 This API will fetches the current volume used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_SetMute (tBTRMgrSoHdl hBTRMgrSoHdl, gboolean Mute)
 This API will set the Mute used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_GetMute (tBTRMgrSoHdl hBTRMgrSoHdl, gboolean *Mute)
 This API will fetches the Mute used by this interface. More...
 
eBTRMgrRet BTRMgr_SO_GetEstimatedInABufSize (tBTRMgrSoHdl hBTRMgrSoHdl, stBTRMgrInASettings *apstBtrMgrSoInASettings, stBTRMgrOutASettings *apstBtrMgrSoOutASettings)
 This API fetches the maximum transmission rate. More...
 
eBTRMgrRet BTRMgr_SO_Start (tBTRMgrSoHdl hBTRMgrSoHdl, stBTRMgrInASettings *apstBtrMgrSoInASettings, stBTRMgrOutASettings *apstBtrMgrSoOutASettings)
 This API uses BTRMgr_SO_GstStart(), starts the pipeline. More...
 
eBTRMgrRet BTRMgr_SO_Stop (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API uses BTRMgr_SO_GstStop() for closing the pipeline. More...
 
eBTRMgrRet BTRMgr_SO_Pause (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API uses BTRMgr_SO_GstPause() for pausing the current operation. More...
 
eBTRMgrRet BTRMgr_SO_Resume (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API uses BTRMgr_SO_GstResume() to resume the status. More...
 
eBTRMgrRet BTRMgr_SO_SendBuffer (tBTRMgrSoHdl hBTRMgrSoHdl, char *pcInBuf, int aiInBufSize)
 Invokes BTRMgr_SO_GstSendBuffer() to add the buffer to the queue. More...
 
eBTRMgrRet BTRMgr_SO_SendEOS (tBTRMgrSoHdl hBTRMgrSoHdl)
 This API is used to indicate the End of stream. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstInit (tBTRMgrSoGstHdl *phBTRMgrSoGstHdl, fPtr_BTRMgr_SO_GstStatusCb afpcBSoGstStatus, void *apvUserData)
 This API initializes the streaming interface. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstDeInit (tBTRMgrSoGstHdl hBTRMgrSoGstHdl)
 This API performs the cleanup operations. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstStart (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, int ai32InBufMaxSize, const char *apcInFmt, int ai32InRate, int ai32InChannels, int ai32OutRate, int ai32OutChannels, const char *apcOutChannelMode, unsigned char aui8SbcAllocMethod, unsigned char aui8SbcSubbands, unsigned char aui8SbcBlockLength, unsigned char aui8SbcMinBitpool, unsigned char aui8SbcMaxBitpool, int ai32BTDevFd, int ai32BTDevMTU)
 This API starts the playback and listens to the events associated with it. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstStop (tBTRMgrSoGstHdl hBTRMgrSoGstHdl)
 This API stops the current playback and sets the state as NULL. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstPause (tBTRMgrSoGstHdl hBTRMgrSoGstHdl)
 This API pauses the current playback and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstResume (tBTRMgrSoGstHdl hBTRMgrSoGstHdl)
 This API resumes the current operation and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstSetInputPaused (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, unsigned char ui8InputPaused)
 This API Sets whether the input of current Buffers is Paused. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstSetVolume (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, unsigned char ui8Volume)
 This API Sets the volume of current operation and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstGetVolume (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, unsigned char *ui8Volume)
 This API Gets the volume of current operation and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstSetMute (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, gboolean mute)
 This API Sets the Mute of current operation and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstGetMute (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, gboolean *mute)
 This API Gets the Mute of current operation and listens to the events. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstSendBuffer (tBTRMgrSoGstHdl hBTRMgrSoGstHdl, char *pcInBuf, int aiInBufSize)
 This API pushes the buffer to the queue. More...
 
eBTRMgrSOGstRet BTRMgr_SO_GstSendEOS (tBTRMgrSoGstHdl hBTRMgrSoGstHdl)
 This API is used to push EOS(End of Stream) to the queue. More...
 

Function Documentation

◆ BTRMgr_SO_Init()

eBTRMgrRet BTRMgr_SO_Init ( tBTRMgrSoHdl *  phBTRMgrSoHdl,
fPtr_BTRMgr_SO_StatusCb  afpcBSoStatus,
void *  apvUserData 
)

This API invokes BTRMgr_SO_GstInit() and also set the state as initialized.

Parameters
[in]phBTRMgrSoHdlHandle to the stream out interface.
[in]afpcBSoStatusCallback function.
[in]apvUserDataData for the callback function.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 77 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_DeInit()

eBTRMgrRet BTRMgr_SO_DeInit ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API invokes BTRMgr_SO_GstDeInit() for the deinitializations.

It also set the state as deinitialized.

Parameters
[in]hBTRMgrSoHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 125 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetDefaultSettings()

eBTRMgrRet BTRMgr_SO_GetDefaultSettings ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API is used to load the default settings used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 160 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetCurrentSettings()

eBTRMgrRet BTRMgr_SO_GetCurrentSettings ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API will fetch the current settings used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 180 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetStatus()

eBTRMgrRet BTRMgr_SO_GetStatus ( tBTRMgrSoHdl  hBTRMgrSoHdl,
stBTRMgrMediaStatus apstBtrMgrSoStatus 
)

This API fetches the media file status.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[out]apstBtrMgrSoStatusStructure which holds the status.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 200 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_SetStatus()

eBTRMgrRet BTRMgr_SO_SetStatus ( tBTRMgrSoHdl  hBTRMgrSoHdl,
stBTRMgrMediaStatus apstBtrMgrSoStatus 
)

This API will set the current settings used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]pstBtrMgrSoStatusStatus of media device that has to be fetched.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 221 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_SetVolume()

eBTRMgrRet BTRMgr_SO_SetVolume ( tBTRMgrSoHdl  hBTRMgrSoHdl,
unsigned char  ui8Volume 
)

This API will set the current volume used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]ui8VolumeVolume of media device that has to be set.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 277 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetVolume()

eBTRMgrRet BTRMgr_SO_GetVolume ( tBTRMgrSoHdl  hBTRMgrSoHdl,
unsigned char *  ui8Volume 
)

This API will fetches the current volume used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]ui8VolumeVolume of media device that has to be fetched.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 298 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_SetMute()

eBTRMgrRet BTRMgr_SO_SetMute ( tBTRMgrSoHdl  hBTRMgrSoHdl,
gboolean  Mute 
)

This API will set the Mute used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]MuteMute of media device that has to be set.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 325 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetMute()

eBTRMgrRet BTRMgr_SO_GetMute ( tBTRMgrSoHdl  hBTRMgrSoHdl,
gboolean *  Mute 
)

This API will fetches the Mute used by this interface.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]MuteMute of media device that has to be fetched.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 343 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GetEstimatedInABufSize()

eBTRMgrRet BTRMgr_SO_GetEstimatedInABufSize ( tBTRMgrSoHdl  hBTRMgrSoHdl,
stBTRMgrInASettings apstBtrMgrSoInASettings,
stBTRMgrOutASettings apstBtrMgrSoOutASettings 
)

This API fetches the maximum transmission rate.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]apstBtrMgrSoInASettingsStructure which holds the audio input settings.
[out]apstBtrMgrSoOutASettingsSaves the MTU information.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 368 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_Start()

eBTRMgrRet BTRMgr_SO_Start ( tBTRMgrSoHdl  hBTRMgrSoHdl,
stBTRMgrInASettings apstBtrMgrSoInASettings,
stBTRMgrOutASettings apstBtrMgrSoOutASettings 
)

This API uses BTRMgr_SO_GstStart(), starts the pipeline.

It also sets the state as playing.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
[in]apstBtrMgrSoInASettingsStructure which holds the audio input settings.
[in]apstBtrMgrSoOutASettingsStructure which holds the audio output settings.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 507 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_Stop()

eBTRMgrRet BTRMgr_SO_Stop ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API uses BTRMgr_SO_GstStop() for closing the pipeline.

Sets the Bluetooth manager state as stopped.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 721 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_Pause()

eBTRMgrRet BTRMgr_SO_Pause ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API uses BTRMgr_SO_GstPause() for pausing the current operation.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 753 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_Resume()

eBTRMgrRet BTRMgr_SO_Resume ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API uses BTRMgr_SO_GstResume() to resume the status.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 783 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_SendBuffer()

eBTRMgrRet BTRMgr_SO_SendBuffer ( tBTRMgrSoHdl  hBTRMgrSoHdl,
char *  pcInBuf,
int  aiInBufSize 
)

Invokes BTRMgr_SO_GstSendBuffer() to add the buffer to the queue.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream outinterface.
[in]pcInBufThe buffer to be added to the queue.
[in]aiInBufSizeBuffer size.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 813 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_SendEOS()

eBTRMgrRet BTRMgr_SO_SendEOS ( tBTRMgrSoHdl  hBTRMgrSoHdl)

This API is used to indicate the End of stream.

Invokes the BTRMgr_SO_GstSendEOS() to push the end of stream. Also sets the bluetooth manager status as completed.

Parameters
[in]hBTRMgrSoHdlHandle to the bluetooth manager stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSuccesson success, appropriate error code otherwise.

Definition at line 844 of file btrMgr_streamOut.c.

◆ BTRMgr_SO_GstInit()

eBTRMgrSOGstRet BTRMgr_SO_GstInit ( tBTRMgrSoGstHdl *  phBTRMgrSoGstHdl,
fPtr_BTRMgr_SO_GstStatusCb  afpcBSoGstStatus,
void *  apvUserData 
)

This API initializes the streaming interface.

Uses gstreamer element "appsrc" for initialization.

Parameters
[in]phBTRMgrSoGstHdlHandle to the stream out interface.
[in]afpcBSoGstStatusStream Out callback function.
[in]apvUserDataData for the callback function.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 300 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstDeInit()

eBTRMgrSOGstRet BTRMgr_SO_GstDeInit ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl)

This API performs the cleanup operations.

Cancels the threads that are running within and frees all associated memory.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 463 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstStart()

eBTRMgrSOGstRet BTRMgr_SO_GstStart ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
int  ai32InBufMaxSize,
const char *  apcInFmt,
int  ai32InRate,
int  ai32InChannels,
int  ai32OutRate,
int  ai32OutChannels,
const char *  apcOutChannelMode,
unsigned char  aui8SbcAllocMethod,
unsigned char  aui8SbcSubbands,
unsigned char  aui8SbcBlockLength,
unsigned char  aui8SbcMinBitpool,
unsigned char  aui8SbcMaxBitpool,
int  ai32BTDevFd,
int  ai32BTDevMTU 
)

This API starts the playback and listens to the events associated with it.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
[in]apcInFmtSupported formats.
[in]ai32InRateInput rate.
[in]ai32InChannelsInput channels.
[in]ai32OutRateOutput rate.
[in]ai32OutChannelsChannels supported.
[in]apcOutChannelModeChannel modes.
[in]aui8SbcAllocMethodAllocation methods.
[in]aui8SbcSubbandsSub bands.
[in]aui8SbcBlockLengthBlocks.
[in]aui8SbcMinBitpoolMin bit pool.
[in]aui8SbcMaxBitpoolMax bit pool.
[in]ai32InBufMaxSizeMaximum buffer size.
[in]ai32BTDevFdInput file descriptor.
[in]ai32BTDevMTUBlock size to read.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 547 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstStop()

eBTRMgrSOGstRet BTRMgr_SO_GstStop ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl)

This API stops the current playback and sets the state as NULL.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 721 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstPause()

eBTRMgrSOGstRet BTRMgr_SO_GstPause ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl)

This API pauses the current playback and listens to the events.

Checks for the current state if it is playing sets the state to pause.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 764 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstResume()

eBTRMgrSOGstRet BTRMgr_SO_GstResume ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl)

This API resumes the current operation and listens to the events.

Checks for the current state if it is paused sets the state to playing.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 796 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstSetInputPaused()

eBTRMgrSOGstRet BTRMgr_SO_GstSetInputPaused ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
unsigned char  ui8InputPaused 
)

This API Sets whether the input of current Buffers is Paused.

Sets the current state, if it is in paused state, with respect to buffer input

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream in interface.
[in]ui8InputPausedInput Buffers Paused.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 828 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstSetVolume()

eBTRMgrSOGstRet BTRMgr_SO_GstSetVolume ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
unsigned char  ui8Volume 
)

This API Sets the volume of current operation and listens to the events.

Checks for the current state, if it is in paused state, playing state is set.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream in interface.
[in]ui8VolumeInput Volume.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 884 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstGetVolume()

eBTRMgrSOGstRet BTRMgr_SO_GstGetVolume ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
unsigned char *  ui8Volume 
)

This API Gets the volume of current operation and listens to the events.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream in interface.
[in]ui8VolumeOutput Volume.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 907 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstSetMute()

eBTRMgrSOGstRet BTRMgr_SO_GstSetMute ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
gboolean  mute 
)

This API Sets the Mute of current operation and listens to the events.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream in interface.
[in]muteInput mute.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 930 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstGetMute()

eBTRMgrSOGstRet BTRMgr_SO_GstGetMute ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
gboolean *  mute 
)

This API Gets the Mute of current operation and listens to the events.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream in interface.
[in]muteOutput mute.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 951 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstSendBuffer()

eBTRMgrSOGstRet BTRMgr_SO_GstSendBuffer ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl,
char *  pcInBuf,
int  aiInBufSize 
)

This API pushes the buffer to the queue.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
[in]pcInBufThe buffer to be added to the queue.
[in]aiInBufSizeBuffer size.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 974 of file btrMgr_streamOutGst.c.

◆ BTRMgr_SO_GstSendEOS()

eBTRMgrSOGstRet BTRMgr_SO_GstSendEOS ( tBTRMgrSoGstHdl  hBTRMgrSoGstHdl)

This API is used to push EOS(End of Stream) to the queue.

Parameters
[in]hBTRMgrSoGstHdlHandle to the stream out interface.
Returns
Returns the status of the operation.
Return values
eBTRMgrSOGstSuccesson success, appropriate error code otherwise.

Definition at line 1102 of file btrMgr_streamOutGst.c.