hxclientcfuncs.cpp

linux下的一款播放器

  @function ClientPlayerGetClipBandwidth
  @param clientPlayerToken
  @result integer indicating current bits per second of the presentation
  @abstract obtain the current presentation's bandwidth
*/
SInt32 ClientPlayerGetClipBandwidth( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetClipBandwidth() : 0;
}

/*!
  @function ClientPlayerSetSize
  @param clientPlayerToken
  @param siteWidth
  @param siteHeight
  @abstract resize the video to the specified dimensions
*/
void ClientPlayerSetSize( HXClientPlayerToken clientPlayerToken, SInt32 siteWidth, SInt32 siteHeight )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer ) pIClientPlayer->SetSize( siteWidth, siteHeight );
}

/*!
  @function ClientPlayerGetSourceCount
  @param clientPlayerToken
  @result the number of sources in the presentation
  @abstract obtain the number of sources in the current presentation
*/
UInt16 ClientPlayerGetSourceCount( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetSourceCount() : 0;
}

/*!
  @function ClientPlayerGetGroupCount
  @param clientPlayerToken
  @result the number of groups in the presentation
  @abstract obtain the number of groups in the current presentation
*/
UInt16 ClientPlayerGetGroupCount( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetGroupCount() : 0;
}

/*!
  @function ClientPlayerGetCurrentGroup
  @param clientPlayerToken
  @result the index of the current group
  @abstract obtain the index of the currently playing group
*/
UInt16 ClientPlayerGetCurrentGroup( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetCurrentGroup() : 0;
}

/*!
  @function ClientPlayerGetGroupURL
  @param clientPlayerToken
  @param groupIndex
  @param pURLBuffer
  @param bufferLength
  @param pUsedBufferLength
  @result true on success, false on fail
  @abstract obtain the url of the specified group
*/
bool ClientPlayerGetGroupURL( HXClientPlayerToken clientPlayerToken, UInt16 groupIndex, char* pURLBuffer, UInt32 bufferLength, UInt32* pUsedBufferLength )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetGroupURL( groupIndex, pURLBuffer, bufferLength, pUsedBufferLength ) : false;
}

/*!
  @function ClientPlayerGetGroupTitle
  @param clientPlayerToken
  @param groupIndex
  @param pTitleBuffer
  @param bufferLength
  @param pUsedBufferLength
  @result true on success, false on fail
  @abstract obtain the title of the specified group
*/
bool ClientPlayerGetGroupTitle( HXClientPlayerToken clientPlayerToken, UInt16 groupIndex, char* pTitleBuffer, UInt32 bufferLength, UInt32* pUsedBufferLength )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetGroupTitle( groupIndex, pTitleBuffer, bufferLength, pUsedBufferLength ) : false;
}

/*!
  @function ClientPlayerSetCurrentGroup
  @param clientPlayerToken
  @param groupIndex
  @result true on success, false on fail
  @abstract skip to the specified group index
*/
bool ClientPlayerSetCurrentGroup( HXClientPlayerToken clientPlayerToken, UInt16 groupIndex )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? ( ( 0 != SUCCEEDED( pIClientPlayer->SetCurrentGroup( groupIndex ) ) ) ? true : false ) : false;
}

/*!
  @function ClientPlayerDrawSite
  @param clientPlayerToken
  @param pSiteRect
  @abstract force the player to redraw the given rect
*/
void ClientPlayerDrawSite( HXClientPlayerToken clientPlayerToken, const SHXClientRect* pSiteRect )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer ) pIClientPlayer->DrawSite( ( const HXxRect* ) pSiteRect );
}

/*!
  @function ClientPlayerSetVolume
  @param clientPlayerToken
  @param volume
  @abstract set the player's volume
*/
void ClientPlayerSetVolume( HXClientPlayerToken clientPlayerToken, UInt16 volume )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer ) pIClientPlayer->SetVolume( volume );
}

/*!
  @function ClientPlayerGetVolume
  @param clientPlayerToken
  @result the player's volume (0-100)
  @abstract obtain the player's volume
*/
UInt16 ClientPlayerGetVolume( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetVolume() : 0;
}

/*!
  @function ClientPlayerMute
  @param clientPlayerToken
  @param shouldMute
  @abstract mute/unmute the player
*/
void ClientPlayerMute( HXClientPlayerToken clientPlayerToken, bool shouldMute )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->Mute( shouldMute );
	}
}

/*!
  @function ClientPlayerIsMuted
  @param clientPlayerToken
  @result true if muted, false if not
  @abstract determine if the player is muted
*/
bool ClientPlayerIsMuted( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->IsMuted() : false;
}

/*!
  @function ClientPlayerEnableEQ
  @param clientPlayerToken
  @param enable
  @abstract enable/disable the equalizer
*/
void ClientPlayerEnableEQ( HXClientPlayerToken clientPlayerToken, bool enable )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->EnableEQ( enable );
	}
}

/*!
  @function ClientPlayerIsEQEnabled
  @param clientPlayerToken
  @result true if enabled, else false
  @abstract determine if the equalizer is enabled
*/
bool ClientPlayerIsEQEnabled( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->IsEQEnabled() : false;
}

/*!
  @function ClientPlayerSetEQGain
  @param clientPlayerToken
  @param band
  @param gain
  @abstract set the specified equalizer band to the given gain
*/
void ClientPlayerSetEQGain( HXClientPlayerToken clientPlayerToken, int band, SInt32 gain )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->SetEQGain( band, gain );
	}
}

/*!
  @function ClientPlayerGetEQGain
  @param clientPlayerToken
  @param band
  @result the given band's gain
  @abstract determine the given equalizer band's gain
*/
SInt32 ClientPlayerGetEQGain( HXClientPlayerToken clientPlayerToken, int band )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetEQGain( band ) : 0;
}

/*!
  @function ClientPlayerSetEQPreGain
  @param clientPlayerToken
  @param preGain
  @abstract set the equalizer's pre-gain
*/
void ClientPlayerSetEQPreGain( HXClientPlayerToken clientPlayerToken, SInt32 preGain )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->SetEQPreGain( preGain );
	}
}

/*!
  @function ClientPlayerGetEQPreGain
  @param clientPlayerToken
  @result the pre-gain
  @abstract obtain the equalizer's pre-gain
*/
SInt32 ClientPlayerGetEQPreGain( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetEQPreGain() : 0;
}

/*!
  @function ClientPlayerEnableEQAutoPreGain
  @param clientPlayerToken
  @abstract enable/disable the equalizer pre-gain
*/
void ClientPlayerEnableEQAutoPreGain( HXClientPlayerToken clientPlayerToken, bool enable )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->EnableEQAutoPreGain( enable );
	}
}

/*!
  @function ClientPlayerIsEQAutoPreGainEnabled
  @param clientPlayerToken
  @result true if enabled, else false
  @abstract determine if equalizer pre-gain is enabled or disabled
*/
bool ClientPlayerIsEQAutoPreGainEnabled( HXClientPlayerToken clientPlayerToken )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->IsEQAutoPreGainEnabled() : false;
}

/*!
  @function ClientPlayerSetEQReverb
  @param clientPlayerToken
  @param roomSize
  @param reverb
  @abstract set the equalizer reverb
*/
void ClientPlayerSetEQReverb( HXClientPlayerToken clientPlayerToken, SInt32 roomSize, SInt32 reverb )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->SetEQReverb( roomSize, reverb );
	}
}

/*!
  @function ClientPlayerGetEQReverb
  @param clientPlayerToken
  @param pRoomSize
  @param pReverb
  @abstract obtain the equalizer reverb
*/
void ClientPlayerGetEQReverb( HXClientPlayerToken clientPlayerToken, SInt32* pRoomSize, SInt32* pReverb )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->GetEQReverb( pRoomSize, pReverb );
	}
}

/*!
  @function ClientPlayerGetVideoAttribute
  @param clientPlayerToken
  @param attributeKey
  @param pAttributeValue
  @result true on success, false on fail
  @abstract obtain the specified video attribute
*/
bool ClientPlayerGetVideoAttribute( HXClientPlayerToken clientPlayerToken, int attributeKey, float* pAttributeValue )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetVideoAttribute( attributeKey, pAttributeValue ) : false;
}

/*!
  @function ClientPlayerSetVideoAttribute
  @param clientPlayerToken
  @param attributeKey
  @param attributeValue
  @result true on success, false on fail
  @abstract set the specified video attribute
*/
bool ClientPlayerSetVideoAttribute( HXClientPlayerToken clientPlayerToken, int attributeKey, float attributeValue )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->SetVideoAttribute( attributeKey, attributeValue ) : false;
}

/*!
  @function ClientPlayerGetStatistic
  @param clientPlayerToken
  @param pStatisticKey
  @param pValueBuffer
  @param bufferLength
  @param pValueType
  @param pUsedBufferLength
  @result true on success, false on fail
  @abstract obtain the type and value of the specified player statistic
*/
bool ClientPlayerGetStatistic( HXClientPlayerToken clientPlayerToken, const char* pStatisticKey, unsigned char* pValueBuffer, UINT32 bufferLength, int* pValueType, UINT32* pUsedBufferLength )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->GetStatistic( pStatisticKey, pValueBuffer, bufferLength, pValueType, pUsedBufferLength ) : false;
}

/*!
  @function ClientPlayerAddStatisticObserver
  @param clientPlayerToken
  @param pStatisticKey
  @param pStatisticsCallbacks
  @param observerInfo
  @result true on success, false on fail
  @abstract set a watch on a statistic
*/
bool ClientPlayerAddStatisticObserver( HXClientPlayerToken clientPlayerToken, const char* pStatisticKey, const HXStatisticsCallbacks* pStatisticsCallbacks, void* observerInfo )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	return pIClientPlayer ? pIClientPlayer->AddStatisticObserver( pStatisticKey, pStatisticsCallbacks, observerInfo ) : false;
}

/*!
  @function ClientPlayerRemoveStatisticObserver
  @param clientPlayerToken
  @param pStatisticKey
  @param pStatisticsCallbacks
  @param observerInfo
  @abstract remove a watch on the specified statistic
*/
void ClientPlayerRemoveStatisticObserver( HXClientPlayerToken clientPlayerToken, const char* pStatisticKey, const HXStatisticsCallbacks* pStatisticsCallbacks, void* observerInfo )
{
	IHXClientPlayer* pIClientPlayer = ( IHXClientPlayer* ) clientPlayerToken;
	if ( pIClientPlayer )
	{
		pIClientPlayer->RemoveStatisticObserver( pStatisticKey, pStatisticsCallbacks, observerInfo );
	}
}