Transcription
TECHNICAL DOCUMENTATIONVAXVOIP SIP SOFTPHONE SDKSIP SOFTPHONE SDKApple iOS(iPhone, iPad, iPod)TECHNICAL DOCUMENTATIONVERSION 6.0Page 1 of 194
TECHNICAL DOCUMENTATIONVAXVOIP SIP SOFTPHONE SDKCONTENTSINTRODUCTION AND QUICK START. 6EXPORTED FUNCTIONS . 7GetVersionFile() . 7GetVersionSDK() . 8AudioDeviceVU() . 9GetAudioInDevTotal() . 10GetAudioOutDevTotal() . 11GetAudioOutDevName() . 12GetAudioInDevName() . 13Initialize() . 14RegisterToProxy() . 17UnRegisterToProxy(). 18OpenLine() . 19CloseLine() . 20GetVaxErrorCode() . 21GetVaxErrorMsg() . 22DialCall(). 23DisconnectCall() . 25AcceptCall(). 26RejectCall() . 27TransferCallBlind() . 28TransferCallConsult() . 29HoldLine() . 30UnHoldLine() . 31IsOpenLine() . 32IsLineConnected() . 33IsLineHold() . 34IsLineBusy() . 35EnableKeepAlive() . 36DisableKeepAlive() . 37SelectAllVoiceCodec() . 38SelectVoiceCodec() . 39DeselectAllVideoCodec(). 40DeselectVoiceCodec() . 41SelectAllVideoCodec() . 42SelectVideoCodec() . 43DeselectAllVideoCodec(). 44DeselectVideoCodec() . 45DigitDTMF() . 46SetVolumeDTMF() . 47GetVolumeDTMF() . 48ForceDigitDTMF() . 49MuteMic() . 50MuteSpk() . 51MuteLineSpk() . 52MuteLineMic() . 53AutoGainMic() . 54Page 2 of 194
TECHNICAL DOCUMENTATIONVAXVOIP SIP SOFTPHONE SDKAutoGainSpk() . 55SetVolumeMic() . 56GetVolumeMic() . 57SetVolumeSpk() . 58GetVolumeSpk() . 59SetLineVolumeSpk() . 60GetLineVolumeSpk() . 61EchoCancellation() . 62DonotDisturb(). 63IsRecording() . 64StartRecording() . 65StopRecording() . 66IsWaveFilePlaying() . 67PlayWaveOpen() . 68PlayWaveClose() . 69PlayWaveSkipTo . 70PlayWaveTotalTime() . 71PlayWavePause() . 72PlayWaveStart() . 73PlayWaveStop() . 74PlayWavePosition() . 75GetOutboundCodec() . 76GetInboundCodec() . 77SetSessionLostTick() . 78SetUSerAgentSIP() . 79GetUserAgentSIP() . 80SetSubjectSDP() . 81GetSubjectSDP() . 82ConfAllowLine(). 83LineVoiceChannelSpk() . 84ChatAddContact() . 85ChatRemoveContact() . 86ChatFindContact() . 87ChatSendMessageTyping() . 88ChatSendMessageText() . 89ChatSetMyStatus() . 90VoiceChanger() . 91ForwardCall(). 92PlayAddPCM() . 93PlayResetPCM(). 94DetectAMD(). 95AddCustomHeader() . 96RemoveCustomHeader() . 97RemoveCustomHeaderAll() . 98GetCountPacketLost() . 99GetSizeJitterBuffer() . 100GetVideoDevTotal() . 101GetVideoDevName() . 102OpenVideoDev() . 103CloseVideoDev() . 104CryptCOMM() . 105BackgroundMode() . 106SpeakerPhone() . 107Page 3 of 194
TECHNICAL DOCUMENTATIONVAXVOIP SIP SOFTPHONE SDKIsSpeakerPhone() . 108DialCallToREC(). 109OpenLineREC() . 110RegisterToProxyREC() . 111UnRegisterToProxyREC() . 113DialRingEnable() . 114DialRingDisable() . 115BusyRingEnable() . 116BusyRingDisable() . 117EnableVideo() . 118GetCallId() . 119IsNetworkAvailable() . 120NetworkReachability() . 121AutoRegistration() . 122VideoCodecBitRate() . 123EXPORTED EVENTS . 124OnInitialized() . 124OnUnInitialized() . 125OnConnectingToRegister() . 126OnTryingToRegister() . 127OnFailToRegister() . 128OnSuccessToRegister() . 129OnConnectingToReRegister() . 130OnTryingToReRegister() . 131OnFailToReRegister() . 132OnSuccessToReRegister() . 133OnTryingToUnRegister() . 134OnFailToUnRegister() . 135OnSuccessToUnRegister() . 136OnTryingToRegisterREC() . 137OnFailToRegisterREC() . 138OnSuccessToRegisterREC() . 139OnTryingToReRegisterREC() . 140OnFailToReRegisterREC() . 141OnSuccessToReRegisterREC() . 142OnTryingToUnRegisterREC() . 143OnFailToUnRegisterREC() . 144OnSuccessToUnRegisterREC() . 145OnDialCallStarted() . 146OnDialingCall() . 147OnDialCallFailed() . 148OnConnectedCall() . 149OnHungupCall() . 150OnInComingCallStarted() . 151OnInComingCallEnded() . 152OnRingToneStarted() . 153OnRingToneEnded() . 154OnTransferCallAccepted() . 155OnTransferCallFailed() . 156OnPlayWaveDone() . 157OnDigitDTMF() . 158Page 4 of 194
TECHNICAL DOCUMENTATIONVAXVOIP SIP SOFTPHONE SDKOnMsgNOTIFY() . 159OnVoiceMailMsg(). 160OnIncomingDiagnostic(). 161OnOutgoingDiagnostic() . 162OnAudioSessionLost() . 163OnSuccessToHold() . 164OnTryingToHold() . 165OnFailToHold() . 166OnSuccessToUnHold() . 167OnTryingToUnHold() . 168OnFailToUnHold() . 169OnChatContactStatus() . 170OnChatSendMsgTextSuccess() . 171OnChatSendMsgTextFail() . 172OnChatSendMsgTypingSuccess() . 173OnChatSendMsgTypingFail() . 174OnChatRecvMsgText() . 175OnChatRecvMsgTypingStart() . 176OnVoiceStreamPCM() . 178OnDetectAMD() . 179OnHoldCall() . 180OnUnHoldCall() . 181OnVideoRemoteStarted() . 182OnVideoRemoteEnded() . 183OnVideoRemoteFrameRGB() . 184OnVideoDeviceFrameRGB() . 185OnServerConnectingREC() . 186OnServerConnectedREC() . 187OnServerFailedREC() . 188OnServerHungupREC() .
TECHNICAL DOCUMENTATION VAXVOIP SIP SOFTPHONE SDK Page 6 of 194 INTRODUCTION AND QUICK START The VaxVoIP SIP softphone SDK is a software development kit which is used to quickly embed SIP (Session Initiation Protocol) based softphone features to web, software and mobile
