Agora C++ API Reference for All Platforms
Public Types | Public Member Functions | Protected Attributes | List of all members
agora::rtc::MccYSDExtension Class Referenceabstract

Public Types

enum  ScoreHardLevel {
  SCORE_HARD_LEVEL1, SCORE_HARD_LEVEL2, SCORE_HARD_LEVEL3, SCORE_HARD_LEVEL4,
  SCORE_HARD_LEVEL5
}
 
enum  ChargeMode { CHARGE_MODE_MONTHLY = 1, CHARGE_MODE_ONCE = 2 }
 
enum  MediaType { MEDIA_TYPE_SONG = 1, MEDIA_TYPE_ACCOMPANY = 2, MEDIA_TYPE_ACCOMPANY_FRAGMENT = 3 }
 

Public Member Functions

 MccYSDExtension ()
 
virtual ~MccYSDExtension ()
 
virtual int initialize (const char *pitchData, const char *lyric, int offset, int segmentOffset, const char *urlToken, IMccYSDInitCallback *callback, MccYSDScoreVersion version=Version_OLD)=0
 
virtual void release ()=0
 
virtual bool isInitialized ()=0
 
virtual void setHttpImpl (IMccHttp *httpClient)=0
 
virtual int setAudioParams (int sampleRate, int channels)=0
 
virtual bool getPitchData (MccYSDPitchData **pitchData, int *count)=0
 
virtual void enableScore (bool enable)=0
 
virtual void setPitch (int16_t pitch)=0
 
virtual const char * getLyric ()=0
 
virtual const char * decryptLyric (const char *lyric)=0
 
virtual int immediatelyDisplay ()=0
 
virtual int updateScore (int pts, MccYSDScoreInfo &scoreInfo)=0
 
virtual int updateAverageScore (int pts)=0
 
virtual int updateTotalScore (int pts)=0
 
virtual int calculateTotalScore ()=0
 
virtual void process (const void *buffer, int size, int pts)=0
 
virtual void reset ()=0
 
virtual void setScoreHardLevel (ScoreHardLevel level)=0
 
virtual int report (IMccYSDReportCallback *callback)=0
 
virtual const char * version ()=0
 
virtual int getMediaResource (const char *deviceId, const char *pid, const char *userId, const char *roomId, const char *token, const char *songId, bool ssl, ChargeMode chargeMode, MediaType mediaType, IMccYSDMediaResourceCallback *response)=0
 
virtual int getMusicSegmentOffset ()=0
 
virtual void setCurrentSongCode (int64_t songCode)
 

Protected Attributes

IMccHttp * m_httpClient
 
int64_t songCode_
 

Member Enumeration Documentation

◆ ScoreHardLevel

enum agora::rtc::MccYSDExtension::ScoreHardLevel
Enumerator
SCORE_HARD_LEVEL1 
SCORE_HARD_LEVEL2 
SCORE_HARD_LEVEL3 
SCORE_HARD_LEVEL4 
SCORE_HARD_LEVEL5 

◆ ChargeMode

enum agora::rtc::MccYSDExtension::ChargeMode
Enumerator
CHARGE_MODE_MONTHLY 
CHARGE_MODE_ONCE 

◆ MediaType

enum agora::rtc::MccYSDExtension::MediaType
Enumerator
MEDIA_TYPE_SONG 
MEDIA_TYPE_ACCOMPANY 
MEDIA_TYPE_ACCOMPANY_FRAGMENT 

Constructor & Destructor Documentation

◆ MccYSDExtension()

agora::rtc::MccYSDExtension::MccYSDExtension ( )
inline

◆ ~MccYSDExtension()

virtual agora::rtc::MccYSDExtension::~MccYSDExtension ( )
inlinevirtual

Member Function Documentation

◆ initialize()

virtual int agora::rtc::MccYSDExtension::initialize ( const char *  pitchData,
const char *  lyric,
int  offset,
int  segmentOffset,
const char *  urlToken,
IMccYSDInitCallback *  callback,
MccYSDScoreVersion  version = Version_OLD 
)
pure virtual

◆ release()

virtual void agora::rtc::MccYSDExtension::release ( )
pure virtual

◆ isInitialized()

virtual bool agora::rtc::MccYSDExtension::isInitialized ( )
pure virtual

◆ setHttpImpl()

virtual void agora::rtc::MccYSDExtension::setHttpImpl ( IMccHttp *  httpClient)
pure virtual

◆ setAudioParams()

virtual int agora::rtc::MccYSDExtension::setAudioParams ( int  sampleRate,
int  channels 
)
pure virtual

◆ getPitchData()

virtual bool agora::rtc::MccYSDExtension::getPitchData ( MccYSDPitchData **  pitchData,
int *  count 
)
pure virtual

◆ enableScore()

virtual void agora::rtc::MccYSDExtension::enableScore ( bool  enable)
pure virtual

◆ setPitch()

virtual void agora::rtc::MccYSDExtension::setPitch ( int16_t  pitch)
pure virtual

◆ getLyric()

virtual const char* agora::rtc::MccYSDExtension::getLyric ( )
pure virtual

◆ decryptLyric()

virtual const char* agora::rtc::MccYSDExtension::decryptLyric ( const char *  lyric)
pure virtual

◆ immediatelyDisplay()

virtual int agora::rtc::MccYSDExtension::immediatelyDisplay ( )
pure virtual

◆ updateScore()

virtual int agora::rtc::MccYSDExtension::updateScore ( int  pts,
MccYSDScoreInfo &  scoreInfo 
)
pure virtual

◆ updateAverageScore()

virtual int agora::rtc::MccYSDExtension::updateAverageScore ( int  pts)
pure virtual

◆ updateTotalScore()

virtual int agora::rtc::MccYSDExtension::updateTotalScore ( int  pts)
pure virtual

◆ calculateTotalScore()

virtual int agora::rtc::MccYSDExtension::calculateTotalScore ( )
pure virtual

◆ process()

virtual void agora::rtc::MccYSDExtension::process ( const void *  buffer,
int  size,
int  pts 
)
pure virtual

◆ reset()

virtual void agora::rtc::MccYSDExtension::reset ( )
pure virtual

◆ setScoreHardLevel()

virtual void agora::rtc::MccYSDExtension::setScoreHardLevel ( ScoreHardLevel  level)
pure virtual

◆ report()

virtual int agora::rtc::MccYSDExtension::report ( IMccYSDReportCallback *  callback)
pure virtual

◆ version()

virtual const char* agora::rtc::MccYSDExtension::version ( )
pure virtual

◆ getMediaResource()

virtual int agora::rtc::MccYSDExtension::getMediaResource ( const char *  deviceId,
const char *  pid,
const char *  userId,
const char *  roomId,
const char *  token,
const char *  songId,
bool  ssl,
ChargeMode  chargeMode,
MediaType  mediaType,
IMccYSDMediaResourceCallback *  response 
)
pure virtual

◆ getMusicSegmentOffset()

virtual int agora::rtc::MccYSDExtension::getMusicSegmentOffset ( )
pure virtual

◆ setCurrentSongCode()

virtual void agora::rtc::MccYSDExtension::setCurrentSongCode ( int64_t  songCode)
inlinevirtual

Member Data Documentation

◆ m_httpClient

IMccHttp* agora::rtc::MccYSDExtension::m_httpClient
protected

◆ songCode_

int64_t agora::rtc::MccYSDExtension::songCode_
protected
Generated by   doxygen 1.8.18