Reference of PTTClient

Description of PTTClient

PTTChannel Group VideoChannel

Properties

nametypeattributesdescription
SDKVersionstringreadonlySDK version information. "1.0.0"
AppVersionstringApp version information.
PlayVolumeint0~100, default 100
MicAmplificationint0~100, default 0
PlayAmplificationint0~100, default 0. This attribute is supported at 1.1.4.
UserNamestringreadonlyUser name. After OnConnected, this is possible.
LocationEnabledbooleanreadonlyUse location servie
UseLocationboolean Whether to use location
VoxEnabledboolean Use VOX. This is depended on PTTClient's VoxSensitivity. default : false
VoxSensitivityint vox sensitivity ( 0 ~ 100 ), default 0(Auto)
BluetoothStatusintreadonly0: Unavailable, 10:Available, 20:Headset Enabled, 23:Button Enabled, 29:Headset+Button Enabled
PushToTalkButtonTypeint 0 : Press And Hold, 1 : Toggle
BluetoothButtonTypeint 0 : Auto Connect. 1 : CODA Wheel/CODA Click, 2 : SHP-612, 3 : Blu-PTT
Languagestring ISO 639-1 alpha-2
SpeakerStatusbooleanreadonly0 : off, 1 : on

Methods

Initialize

int Initialize(string LicenseKey)
LicenseKeyLicenseKey. It can be generated at http://dev.proptt2.com/account-licenses.php
Return0: Possible ID, 0
DescriptionInitialize PTTClient
SDK version1.1.1
SampleInitialize("S0000000-C7A378675F4D002E887191FB22DF65EC-81B195BB");

Uninitialize

void Uninitialize()
DescriptionUninitialize PTTClient
SDK version1.1.1
SampleUninitialize();

Connect

int Connect(string UserID, string Password, int LastNotificationID, string pushToken, PTTClientEvent* EventHandler)
int Connect(string ServerIP, int ServerPort, string UserID, string Password, int lastNotificationID, string pushToken, PTTClientEvent* EventHandler)
ServerIPProPTT2 server's IP
ServerPortProPTT2 server's port. It must be 8080.
UserIDUser ID
PasswordSha512(User's password)
LastNotificationIDNotification ID is saved in a client.
PushTokenPush Token in App(iOS, Android). Windows is """.
EventHandlerEvent Handler to receive events
Return0:Call Success, 0<ErrorCode
Expected EventsOnProvisioned()->OnConnected()->OnSetup()->OnChannels->OnMembers()->OnGroups()->OnBuddies()->OnPresenceUpdated()->OnPresenceUpdated()
DescriptionConnect to ProPTT2 server system
SDK version1.1.1

Disconnect

int Disconnect(boolean Logout)
Logoutif true, the login session will be logged out.
Return0:Call Success, 0<ErrorCode
Expected EventsOnDisconnected()
DescriptionDisconnect from ProPTT2 server system
SDK version1.1.1

UpdateProfile

int UpdateProfile(string ProfileAttributesJson)
ProfileAttributesJsonProfile's Attributes.
ReturnRequest Sequence ID. If less then 0, ErrorCode
Expected EventsOnProfileUpdated
DescriptionUpdate user's profile attributes
SDK version1.1.1
< ProfileAttributesJson >
fieldtypeDescriptionDefaultCRUD
UserIDstringUser's ID MM
NamestringUser's name MMO
PasswordstringSha512(password). It is for just update. M O
Typestring'N'ormal, 'A'sp, 'P'ackage MO
EmailstringUser's email MOO
ExpireDatestringPaid datetime O
PhoneNumberstringex)821012341234 OOO
NicknamestringURLEncode(User’s Nickname) (MAX 255char). OMO
StatusTextstirngURLEncode(User’s StatusText) (MAX 255char) MO
VASstirngUser's Option of the Value-Added Service
Set to a digits of string
if value is "1", the option is enabled. otherwise disabled. if empty is all enable.
(0:AwakeUser, 1: InviteUser, 2: SubscribeChannel, 3: AddBuddy, 4:VideoPTT, 5: AwakeChannel)
OO
VisibleintWhether to allow for searching by another user OO
LanguagestringISO 639-1 alpha-2 OOO

GetProfile

int GetProfile(string UserID)
UserIDUser ID
ReturnRequest Sequence ID. If less then 0, ErrorCode
Expected EventsOnProfile()
DescriptionGet user's profile
SDK version1.1.1

SearchProfile

int SearchProfile(string Keyword)
KeywordSearch keyword, "" is not possible.
ReturnRequest Sequence ID. If less then 0, ErrorCode
Expected EventsOnProfileSearched()
DescriptionSearch profiles by keyword.
SDK version1.1.1

UpdateProvision

int UpdateProvision(string ProvisionAttributesJson)
ProvisionAttributesJsonProvision's attributes
ReturnRequest Sequence ID. If less then 0, ErrorCode
DescriptionUpdate user's provision
SDK version1.1.1
< ProvisionAttributesJson >
fieldtypeDescriptionDefaultCRUD
EnableVideoPTTbooleanUse video on PTT O
EnableHDAudioPTTbooleanUse HD audio on PTT O

UpdatePresence

int UpdatePresonce(string PresenceAttributesJson)
PresenceAttributesJsonPresence's attributes
ReturnRequest Sequence ID. If less then 0, ErrorCode
Expected EventsOnUpdatePresence()
DescriptionUpdate user's presence
SDK version1.1.1
< ProvisionAttributesJson >
fieldtypeDescriptionDefaultCRUD
Statusint0:Offline,1:Online,2:Busy O

UpdatePhoto

int UpdatePhoto(string int PhotoType, int PhotoDataLength, byte[] PhotoDataBuffer)
int UpdatePhoto(string FilePath)
PhotoTypePhoto Type (20: BMP, 31: JPEG, 32 PNG)
PhotoDataLengthData size
PhotoDataBufferBuffer of data
FilePathPath of photo
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnPhotoUpdated
DescriptionUpdate own photo
picture size should be less than 320 x 320
SDK version1.1.1

GetBuddyPhoto

int GetBuddyPhoto(string UserID)
UserIDUser ID to get photo.
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnBuddyPhotoReceived
DescriptionRequest to get photo
SDK version1.1.1

GetChannels

int GetChannels()
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnChannels
DescriptionRequest channel list
SDK version1.1.1

GetChannelInfo

int GetChannelInfo(int ChannelID)
ChannelIDChannel's ID
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnChannel
DescriptionRequest channel info
SDK version1.1.1

SearchChannel

int SearchChannel(string Keyword, string Code)
KeywordSearch keyword, "" is not possible.
CodeSearch Code, "" is not possible.
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnChannelSearched
DescriptionSearch channels by keyword or code.
SDK version1.1.1

GetMembers

int GetMembers()
int GetMembers(int ChannelID)
ChannelIDChannel's ID to get members
Return Request Sequence ID. If less then 0, ErrorCode.
Expected EventsOnMembers
DescriptionRequest members of channels
SDK version1.1.1

GetGroups

int GetGroups()
Return Request Sequence ID. If less then 0, ErrorCode.
Expected Events OnGroups()->OnBuddies()
DescriptionRequest BuddyGroups
SDK version1.1.1

GetBuddies

int GetBuddies()
int GetBuddies(int GroupID)
GroupIDGroup's ID to get buddies
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnBuddies()
DescriptionRequest Buddy list
SDK version1.1.1

GetOrganizations

int GetOrganization()
Return Request Sequence ID. If less then 0, ErrorCode.
Expected EventsOnOrganizations
DescriptionRequest organizations
SDK version1.1.1

GetUsers

int GetUsers()
int GetUsers(int OrganizationID)
OrganizationIDOrganization's ID to get users
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnUsers
DescriptionRequest user list
SDK version1.1.1

CreatePTTChannel

int CreatePTTChannel(string ChannelAttributesJson)
ChannelAttributesJsonChannel's attributes
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnChannelCreated
DescriptionCreate PTTChannel
SDK version1.1.1
< ChannelAttributesJson >
fieldtypeDescriptionDefaultCRUD
NostringChannel number or code MO
ChannelNamestringURLEncode(Channel name)MMO
ChannelTypestring'S'ystem,'F'ree,'P'rivate,'C'ompany,'G'roup,'1':1MM
IsRecordablebooleanIs RecordabletrueMOO
TOTintChannel’s TOT30MOO
IsOwnerbooleanChannel’s owner O
IsEncryptedbooleanIs EncryptedfalseOOO
DescriptionstringURLEncode(DescriptionOOO
NotificationstringURLEncode(Notification)OOO
FunctionstringFunction name O
Statusint Status joined the Channel

SubscribePTTChannel

int SubscribePTTChannel(int ChannelID)
int Subscribe(int ChannelID, string InvitationCode)
ChannelID Channel ID to subscribe
InvitationCodeIf user is invited, user has the invitation code.
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionSubscribe to channel
SDK version1.1.1

OpenPTTChannel

int OpenPTTChannel(int ChannelID, PTTChannelEvent EventHandler)
ChannelID Channel ID to open
EventHandlerEvent handler to receive events
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnChannelOpened
DescriptionOpen PTT channel instance
SDK version1.1.1

ClosePTTChannel

int ClosePTTChannel(PTTChannel PTTChannelInstance)
PTTChannelInstance PTTChannel Instance to close
ReturnRequest Sequence ID. If less then 0, ErrorCode.
DescriptionClose PTT channel instance
SDK version1.1.1

OpenGroup

int OpenGroup(int GroupID, GroupEvent EventHandler)
GroupIDGroup's ID to open
EventHandlerEvent handler to receive events
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnGroupOpened
DescriptionOpen Buddy Group
SDK version1.1.1

CloseGroup

int CloseGroup(Group GroupInstance)
GroupInstanceGroup instance to be closed
ReturnRequest Sequence ID. If less then 0, ErrorCode.
DescriptionClose Group
SDK version1.1.1

GetNotices

int GetNotices(int NoticeID, int Count)
NoticeIDFirst Notice's ID to get
CountCount to get
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected EventsOnNotices
DescriptionRequest Notice list
SDK version1.1.1

AwakeUser

int AwakeUser(string UserID)
UserIDUser ID to receive notify
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionRequest to send Awake notify
SDK version1.1.1

AwakeChannelUser

int AwakeUser(int ChannelID, string UserID)
ChannelIDChannel ID to request
UserIDUser ID to receive notify
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionRequest to send Awake notify to Channel User
SDK version1.1.1

SetActive

int SetActive(boolean IsActive)
IsActiveIs Active
Return0:Success, 0<ErrorCode
Expected Events
DescriptionSet app staus. default active
SDK version1.1.1

SetSpeakerPhone

int SetSpeakerPhone(boolean Enable)
EnableUse speaker phone
Return0:Success, 0<ErrorCode
DescriptionUse speaker phone. default false
SDK version1.1.1

GetCameraList

string GetCameraList()
Returncamera list seperated by ','
Expected Events
Descriptionget camera list
SDK version1.1.1

SetCamera

int SetCamera(string CameraName)
CameraNameCamera Name to be used
Return0:Success, 0<ErrorCode
Expected Events
DescriptionUse camera. default face camera
SDK version1.1.1

EnableBluetooth

int EnableBluetooth(type DeviceType)
DeviceTypeAndroid, IOS : int
20:Headset, 23:Button, 29:Headset+Button

Windows : string
bluetooth Port Name
Return0:Success, 0<ErrorCode
Expected EventsOnBluetoothStatusChanged
DescriptionUse bluetooth device
SDK version1.1.1

DisableBluetooth

int DisableBluetooth(type DeviceType)
DeviceTypeAndroid, IOS : int
20:Headset, 23:Button, 29:Headset+Button

Windows : string
bluetooth Port Name
Return0:Success, 0<ErrorCode
Expected EventsOnBluetoothStatusChanged
DescriptionDisable bluetooth device
SDK version1.1.1

SetBluetoothMode

int SetBluetoothMode(int mode)
mode0 : None (default)
10 : Battery Save Mode
Return0:Success, 0<ErrorCode
Expected Events
DescriptionChange Bluetooth Mode

default 0 mode always works bluetooth Headset
if you enableBluetooth "Heaset" or "Headset + Button"

If you set Battery Save Mode, Bluetooth Headset only works
in channel Locked if you enableBluetooth "Heaset" or "Headset + Button"
SDK version1.2.0

GetBluetoothMode

int GetBluetoothMode()
Return0:Success, 0<ErrorCode
Expected Events
DescriptionGet current Bluetooth mode
SDK version1.2.0

StartTestVox

int StartTestVox()
Return0:Success, 0<ErrorCode
DescriptionUse bluetooth device
SDK version1.1.1

StopTestVox

int StopTestVox()
Return0:Success, 0<ErrorCode
Expected Events
DescriptionDisable bluetooth device
SDK version1.1.1

OpenVideoAnnouncerChannel

VideoChannel OpenVideoAnnouncerChannel(VideoChannelEvent EventHandler)
EventHandlerEvent handler to receive events
ReturnOpened Video Channel's Instance
Expected Events
DescriptionOpen Video channel instance for announcer
SDK version1.1.1

OpenVideoPlayerChannel

VideoChannel OpenVideoPlayerChannel(int VideoChannelID, VideoChannelEvent EventHandler)
VideoChannelIDVideo Channel's ID to join
EventHandlerEvent handler to receive events
ReturnOpened Video Channel's Instance
Expected Events
DescriptionOpen Video channel instance to join
SDK version1.1.1

CloseVideoChannel

int OpenPTTChannel(VideoChannel VideoChannelInstance)
VideoChannelInstanceVideo Channel Instance to close
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionClose Video channel instance
SDK version1.1.1

SendPrivateMessage

int SendPrivateMessage(string ReceiverID, string Message)
ReceiverID Receiver ID to be received a message.
Message Max 200 characters
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionSend Message to Receiver
Server version1.2.x~
SDK version1.2.0

SendPrivateCustomMessage

int SendPrivateCustomMessage(string ReceiverID, byte[] DataBuffer, int DataLength)
ReceiverID Receiver ID to be received a message.
DataBuffer Buffer of data
DataLength Data size ( Max 30k )
ReturnRequest Sequence ID. If less then 0, ErrorCode.
Expected Events
DescriptionSend a CustomMessage to Receiver.
Server version1.2.x~
SDK version1.2.0

Events

OnError

OnError(int ErrorCode, string ErrorMesssage)
ErrorCodeError code. see Main 6
ErrorMesssageError message
DescriptionErrer event
SDK version1.1.1

OnResult

OnResult(int Seq, int ResultCode, string ResultMesssage)
SeqRequested Sequence ID
ResultCodeError code. see Main 7
ResultMesssageError message
DescriptionResult event for request
SDK version1.1.1

OnProvisioned

OnProvisioned(string InitialJson)
InitialJson
DescriptionConnected to server.
SDK version1.1.1
< InitialJson >
fieldtypeDescriptionDefault
UserNamestringUser's name
In case of guest, name is ''.
NationCodestringUser's pysical location. ISO 3166-1 alpha-2
NewNotificationCountintNotification count after
LastNotificationID
LastAppVersionstringLast App version
UserEmailstringUser's email
CheckedEmailbooleanIs verified email?false
ExpireTimestringExpire Time(GMT0) , ex) 2015-05-21 20:10:12Unlimit
MinAppVersionstringMinimum App version1.0.0
UpgradeURLstring"store" : app store
URL : visit web
store
EnableVideoSharingbooleanenable video sharingfalse
EnablePhotoSharingbooleanenable photo sharing false
EnableGroupChannelbooleanenable to create group PTT channel.(for Cloud/Package)false
EnableDispatchingbooleanenable dispatching service for Dispatcherfalse
EnablePushbooleanenable push featurefalse
RequiredLocationbooleanenable location sendingfalse
FAQURLstringURL : visit webPC: http://www.proptt.com/xx/faq.htm
smart device http://www.proptt.com/xx/mfaq.htm
xx means language code. ex) 'en', 'ko', 'zh'
HomepagestringURL : visit webwww.proptt.com
LogoIDintIf it is not 0 and not same with local LogoID, must download itProPTT logo

OnConnected

OnConnected()
DescriptionConnected to server.
SDK version1.1.1

OnSetup

OnSetup()
DescriptionSetup to server.
SDK version1.1.1

OnDisconnected

OnDisconnected(int Reason)
ReasonWhether the session log out.
0: Network Error
1: Log-out
2: Duplicate Log-in
3: Upgrade
4: Invalid License
5: Invalid Account
DescriptionDisconnected to server.
SDK version1.1.1

OnProfileUpdated

OnProfileUpdated(string ProfileAttributesJson)
ProfileAttributesJsonUpdated attributes
DescriptionProfile is updated.
SDK version1.1.1

OnProfile

OnProfile(string ProfileAttributeJson)
ProfileAttributeJsonProfile attributes
DescriptionResponse of GetProfile.
SDK version1.1.1

OnProfileSearched

OnProfileSearched(string ProfilesJson)
ProfilesJsonProfile list
DescriptionResponse of SearchProfile.
SDK version1.1.1
< ProfilesJson >
fieldtypeDescriptionDefaultR
Profilestring O
  ProfileAttributesstringProfileAttributesJson M

OnProvisionUpdated

OnProvisionUpdated(string ProvisionAttributeJson)
ProvisionAttributeJsonUpdated attributes
DescriptionProvision is updated.
SDK version1.1.1

OnPresenceUpdated

OnPresonceUpdated(string PresenceAttributesJson)
PresenceAttributesJsonAttributes
DescriptionPresence is updated
SDK version1.1.1

OnPhotoUpdated

OnPhotoUpdated(int PhotoChangeNumber)
PhotoChangeNumberPhoto's change number
DescriptionPhoto is updated
SDK version1.1.1

OnBuddyPhotoReceived

OnBuddyPhotoReceived(string UserID, int PhotoType, int PhotoDataLength, byte[] PhotoDataBuffer)
OnBuddyPhotoReceived(string UserID, string PhotoURL)
UserIDUser ID of photo
PhotoTypePhoto Type (20: BMP, 31: JPEG, 32 PNG)
PhotoDataLengthData size
PhotoDataBufferBuffer of data
PhotoURLURL to receive photo
DescriptionResponse of GetBuddyPhoto
SDK version1.1.1

OnChannelCreated

OnChannelCreated(int ChannelID)
ChannelIDCreated Channel's ID
DescriptionPTTChannel is created.
SDK version1.1.1

OnChannelUpdated

OnChannelUpdated(string ChannelAttributesJson)
ChannelAttributesJsonAttributes
DescriptionPTTChannel is updated by owner.
SDK version1.1.1

OnChannelDeleted

OnChannelDeleted(int ChannelID)
ChannelIDDeleted Channel's ID
DescriptionPTTChannel is deleted.
SDK version1.1.1

OnChannelOpened

OnChannelOpened(PTTChannel PTTChannelInstance)
PTTChannelInstanceOpened Channel's Instance
DescriptionPTTChannel Instance is opened.
SDK version1.1.1

OnChannels

OnChannels(string ChannelsJson)
ChannelsJson
DescriptionResponse of GetChannels
SDK version1.1.1
< ChannelsJson >
fieldtypeDescriptionDefaultR
ChannelstringO
  ChannelAttributesstringChannelAttributesJsonM

OnChannel

OnChannel(string ChannelAttributesJson)
ChannelAttributesJson
DescriptionResponse of GetChannelInfo
SDK version1.1.1

OnChannelSearched

OnChannelSearched(string ChannelsJson)
ChannelsJsonChannel list
DescriptionResponse of SearchChannel.
SDK version1.1.1

OnMembers

OnMembers(string MembersJson)
MembersJsonresult(Json)
DescriptionResponse of GetMembers
SDK version1.1.1
< MembersJson >
fieldtypeDescriptionDefaultR
MemberO
  UserIDstringMember’s IDM
  NamestringURLEncode(Member’s name)M
  JoinedChannelO
    ChannelIDstringJoined Channel IDM
  WaitedChannelO
    ChannelIDstringWaited ChannelLIDM
    InvitorIDstringM
    InvitorNamestringM

OnGroupOpened

OnGroupCreated(Group GroupInstance)
GroupInstanceOpened Group's Instance
DescriptionGroup Instance is opened.
SDK version1.1.1

OnGroups

OnGroups(string GroupsJson)
GroupsJson
DescriptionResponse of GetGroups
SDK version1.1.1
< GroupsJson >
fieldtypeDescriptionDefaultR
GroupO
  IDintGroup’s IDM
  NamestringURLEncode(Group's Name) M
  Typeint0:Normal M

OnBuddies

OnResponseBuddies(string BuddiesJson)
BuddiesJsonresult(Json)
DescriptionResponse of GetBuddies
SDK version1.1.1
< BuddiesJson >
fieldtypeDescriptionDefaultR
BuddyO
  UserLIDstringBuddy IDM
  UserNamestringBuddy NameM
  GroupIDintGroup ID M
  Statusint10: registed, 20: requesting: 30: accepted

OnOrganizations

OnOrganizations(string OrganizationsJson)
OrganizationsJson
DescriptionResponse of GetOrganizations
SDK version1.1.1
< OrganizationJson >
fieldtypeDescriptionDefaultR
OrganizationO
  IDintOrganization’s IDM
  NamestringURLEncode(Organization's Name)M
  Typeint0:NormalM

OnUsers

OnUsers(string UsersJson)
UsersJsonresult(Json)
DescriptionResponse of GetUsers
SDK version1.1.1
< UsersJson >
fieldtypeDescriptionDefaultR
UserO
  UserLIDstringUser's IDM
  UserNamestringUser's NameM
  IncludedGroupsO
    OrganizationIDintOrganization’s IDM

OnBuddyRequested

OnBuddyRequested(int GroupID, string RequesterID, string RequesterName)
GroupIDGroup ID of event
RequesterIDUser ID who have added me
RequesterNameUser Name who have added me
DescriptionResponse of GetUsers
SDK version1.1.1

OnBuddyAccepted

OnBuddyAccepted(int GroupID, string UserID)
GroupIDGroup ID of event
UserIDSubscriber's ID
DescriptionSubscribed into a Buddy Group
SDK version1.1.1

OnBuddyDenied

OnBuddyDenied(int ChannelID, string UserID)
GroupIDGroup ID of event
UserIDSubscriber's ID
DescriptionUser is joined into a Buddy Group
SDK version1.1.1

OnSubscribeRequested

OnSubscribeRequested(int ChannelID, string MemberID, string MemberName)
ChannelIDChannel ID of event
MemberIDSubscriber's ID
MemberNameSubscriber's Name
DescriptionRequested a subscription into a PTT channel.
SDK version1.1.1

OnSubscribeAccepted

OnSubscribeAccepted(int ChannelID, string MemberID, string MemberName)
ChannelIDChannel ID of event
MemberIDSubscriber's ID
MemberNameSubscriber's Name
DescriptionSubscribed into a PTT channel
SDK version1.1.1

OnSubscribeDenied

OnSubscribeDenied(int ChannelID, string MemberID)
ChannelIDChannel ID of event
MemberIDSubscriber's ID
DescriptionUser is joined into a PTT channel.
SDK version1.1.1

OnUnsubscribed

OnUnsubscribed(int ChannelID, string MemberID, string OwnerID)
ChannelIDChannel ID of event
MemberIDUnsubscriber's ID
OwnerIDChannel owner's ID
DescriptionUser is joined into a PTT channel.
SDK version1.1.1

OnSubscribeCanceled

OnSubscribeCanceled(int ChannelID, string MemberID)
ChannelIDChannel ID of event
MemberIDRequester's ID for cancel
DescriptionCanceled to subscribe
SDK version1.1.1

OnInviteRequested

OnInviteRequested(int ChannelID, string channelName, string RequesterID, string RequesterName, string ReceiverID, string ReceiverName)
ChannelIDChannel ID of event
ChannelNameChannel Name
RequesterIDRequester ID
RequesterNameRequester Name
ReceiverIDReceiver ID
ReceiverNameReceiver Name
DescriptionInvited from another peer
SDK version1.1.1

OnInviteAccepted

OnInvitedAccepted(int ChannelID, string SenderID, string ReceiverID, string ReceiverName)
ChannelIDChannel ID of event
SenderIDSender ID
ReceiverIDReceiver ID
ReceiverNameReceiver Name
Descriptionaccepted to invite PTT channel
SDK version1.1.1

OnInviteDenied

OnInvitedDenied(int ChannelID, string RequesterID, string ReceiverID, string ReceiverName)
ChannelIDChannel ID of event
RequesterIDRequester ID
ReceiverIDReceiver ID
Descriptiondenied to invite PTT channel
SDK version1.1.1

OnInviteCanceled

OnInvitedCanceled(int ChannelID, string ReceiverID)
ChannelIDChannel ID of event
ReceiverIDReceiver ID
DescriptionCanceled to invite
SDK version1.1.1

OnNotices

OnNotices(string NoticesJson)
ChannelsJson
DescriptionResponse of GetNotices
SDK version1.1.1
< NoticesJson >
fieldtypeDescriptionDefaultR
NoticeO
  IdintNotice IDM
  TitlestringTitle of NoticeM
  ContentstringContent of NoticeM
  Typeint10: NormalM
  UpdateDatestringDate to update NoticeM

OnAwakeUser

OnAwakeUser(string UserID)
UserIDUser ID to receive notify
DescriptionResponse of AwakeUser
SDK version1.1.1

OnAwakeChannelUser

OnAwakeChannelUser(int ChannelID, string UserID)
ChannelIDChannel ID of event
UserIDUser ID to receive notify
DescriptionResponse of AwakeChannelUser
SDK version1.1.1

OnBluetoothStatusChanged

OnBluetoothStatusChanged(int BluetoothStatus)
BluetoothStatus0: Unavailable, 10:Available, 20:Headset Enabled, 23:Button Enabled, 29:Headset+Button Enabled
DescriptionBluetooth device's status is changed
SDK version1.1.1

OnVoxDataCaptured

OnVoxDataCaptured(byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp)
TrackDataBufferBuffer of data
DataLengthData size
TimestampTimestamp of data
DescriptionVox data is captured from device.
SDK version1.1.1