Reference of PTTClient
Description of PTTClient
PTTChannel Group VideoChannelProperties
| name | type | attributes | description |
|---|---|---|---|
| SDKVersion | string | readonly | SDK version information. "1.0.0" |
| AppVersion | string | App version information. | |
| PlayVolume | int | 0~100, default 100 | |
| MicAmplification | int | 0~100, default 0 | |
| PlayAmplification | int | 0~100, default 0. This attribute is supported at 1.1.4. | |
| UserName | string | readonly | User name. After OnConnected, this is possible. |
| LocationEnabled | boolean | readonly | Use location servie |
| UseLocation | boolean | Whether to use location | |
| VoxEnabled | boolean | Use VOX. This is depended on PTTClient's VoxSensitivity. default : false | |
| VoxSensitivity | int | vox sensitivity ( 0 ~ 100 ), default 0(Auto) | |
| BluetoothStatus | int | readonly | 0: Unavailable, 10:Available, 20:Headset Enabled, 23:Button Enabled, 29:Headset+Button Enabled |
| PushToTalkButtonType | int | 0 : Press And Hold, 1 : Toggle | |
| BluetoothButtonType | int | 0 : Auto Connect. 1 : CODA Wheel/CODA Click, 2 : SHP-612, 3 : Blu-PTT | |
| Language | string | ISO 639-1 alpha-2 | |
| SpeakerStatus | boolean | readonly | 0 : off, 1 : on |
Methods
Initialize
| int Initialize(string LicenseKey) | |
| LicenseKey | LicenseKey. It can be generated at http://dev.proptt2.com/account-licenses.php |
|---|---|
| Return | 0: Possible ID, 0 |
| Description | Initialize PTTClient |
| SDK version | 1.1.1 |
| Sample | Initialize("S0000000-C7A378675F4D002E887191FB22DF65EC-81B195BB"); |
Uninitialize
| void Uninitialize() | |
| Description | Uninitialize PTTClient |
|---|---|
| SDK version | 1.1.1 |
| Sample | Uninitialize(); |
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) | |
| ServerIP | ProPTT2 server's IP |
|---|---|
| ServerPort | ProPTT2 server's port. It must be 8080. |
| UserID | User ID |
| Password | Sha512(User's password) |
| LastNotificationID | Notification ID is saved in a client. |
| PushToken | Push Token in App(iOS, Android). Windows is """. |
| EventHandler | Event Handler to receive events |
| Return | 0:Call Success, 0<ErrorCode |
| Expected Events | OnProvisioned()->OnConnected()->OnSetup()->OnChannels->OnMembers()->OnGroups()->OnBuddies()->OnPresenceUpdated()->OnPresenceUpdated() |
| Description | Connect to ProPTT2 server system |
| SDK version | 1.1.1 |
Disconnect
| int Disconnect(boolean Logout) | |
| Logout | if true, the login session will be logged out. |
|---|---|
| Return | 0:Call Success, 0<ErrorCode |
| Expected Events | OnDisconnected() |
| Description | Disconnect from ProPTT2 server system |
| SDK version | 1.1.1 |
UpdateProfile
| int UpdateProfile(string ProfileAttributesJson) | |
| ProfileAttributesJson | Profile's Attributes. |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode |
| Expected Events | OnProfileUpdated |
| Description | Update user's profile attributes |
| SDK version | 1.1.1 |
| field | type | Description | Default | C | R | U | D |
|---|---|---|---|---|---|---|---|
| UserID | string | User's ID | M | M | |||
| Name | string | User's name | M | M | O | ||
| Password | string | Sha512(password). It is for just update. | M | O | |||
| Type | string | 'N'ormal, 'A'sp, 'P'ackage | M | O | |||
| string | User's email | M | O | O | |||
| ExpireDate | string | Paid datetime | O | ||||
| PhoneNumber | string | ex)821012341234 | O | O | O | ||
| Nickname | string | URLEncode(User’s Nickname) (MAX 255char). | O | M | O | ||
| StatusText | stirng | URLEncode(User’s StatusText) (MAX 255char) | M | O | |||
| VAS | stirng | User'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) | O | O | |||
| Visible | int | Whether to allow for searching by another user | O | O | |||
| Language | string | ISO 639-1 alpha-2 | O | O | O |
GetProfile
| int GetProfile(string UserID) | |
| UserID | User ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode |
| Expected Events | OnProfile() |
| Description | Get user's profile |
| SDK version | 1.1.1 |
SearchProfile
| int SearchProfile(string Keyword) | |
| Keyword | Search keyword, "" is not possible. |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode |
| Expected Events | OnProfileSearched() |
| Description | Search profiles by keyword. |
| SDK version | 1.1.1 |
UpdateProvision
| int UpdateProvision(string ProvisionAttributesJson) | |
| ProvisionAttributesJson | Provision's attributes |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode |
| Description | Update user's provision |
| SDK version | 1.1.1 |
| field | type | Description | Default | C | R | U | D |
|---|---|---|---|---|---|---|---|
| EnableVideoPTT | boolean | Use video on PTT | O | ||||
| EnableHDAudioPTT | boolean | Use HD audio on PTT | O |
UpdatePresence
| int UpdatePresonce(string PresenceAttributesJson) | |
| PresenceAttributesJson | Presence's attributes |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode |
| Expected Events | OnUpdatePresence() |
| Description | Update user's presence |
| SDK version | 1.1.1 |
| field | type | Description | Default | C | R | U | D |
|---|---|---|---|---|---|---|---|
| Status | int | 0:Offline,1:Online,2:Busy | O |
UpdatePhoto
| int UpdatePhoto(string int PhotoType, int PhotoDataLength, byte[] PhotoDataBuffer) int UpdatePhoto(string FilePath) | |
| PhotoType | Photo Type (20: BMP, 31: JPEG, 32 PNG) |
|---|---|
| PhotoDataLength | Data size |
| PhotoDataBuffer | Buffer of data |
| FilePath | Path of photo |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnPhotoUpdated |
| Description | Update own photo picture size should be less than 320 x 320 |
| SDK version | 1.1.1 |
GetBuddyPhoto
| int GetBuddyPhoto(string UserID) | |
| UserID | User ID to get photo. |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnBuddyPhotoReceived |
| Description | Request to get photo |
| SDK version | 1.1.1 |
GetChannels
| int GetChannels() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | OnChannels |
| Description | Request channel list |
| SDK version | 1.1.1 |
GetChannelInfo
| int GetChannelInfo(int ChannelID) | |
| ChannelID | Channel's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnChannel |
| Description | Request channel info |
| SDK version | 1.1.1 |
SearchChannel
| int SearchChannel(string Keyword, string Code) | |
| Keyword | Search keyword, "" is not possible. |
|---|---|
| Code | Search Code, "" is not possible. |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnChannelSearched |
| Description | Search channels by keyword or code. |
| SDK version | 1.1.1 |
GetMembers
| int GetMembers() int GetMembers(int ChannelID) | |
| ChannelID | Channel's ID to get members |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnMembers |
| Description | Request members of channels |
| SDK version | 1.1.1 |
GetGroups
| int GetGroups() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | OnGroups()->OnBuddies() |
| Description | Request BuddyGroups |
| SDK version | 1.1.1 |
GetBuddies
| int GetBuddies() int GetBuddies(int GroupID) | |
| GroupID | Group's ID to get buddies |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnBuddies() |
| Description | Request Buddy list |
| SDK version | 1.1.1 |
GetOrganizations
| int GetOrganization() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | OnOrganizations |
| Description | Request organizations |
| SDK version | 1.1.1 |
GetUsers
| int GetUsers() int GetUsers(int OrganizationID) | |
| OrganizationID | Organization's ID to get users |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnUsers |
| Description | Request user list |
| SDK version | 1.1.1 |
CreatePTTChannel
| int CreatePTTChannel(string ChannelAttributesJson) | |
| ChannelAttributesJson | Channel's attributes |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnChannelCreated |
| Description | Create PTTChannel |
| SDK version | 1.1.1 |
| field | type | Description | Default | C | R | U | D |
|---|---|---|---|---|---|---|---|
| No | string | Channel number or code | M | O | |||
| ChannelName | string | URLEncode(Channel name) | M | M | O | ||
| ChannelType | string | 'S'ystem,'F'ree,'P'rivate,'C'ompany,'G'roup,'1':1 | M | M | |||
| IsRecordable | boolean | Is Recordable | true | M | O | O | |
| TOT | int | Channel’s TOT | 30 | M | O | O | |
| IsOwner | boolean | Channel’s owner | O | ||||
| IsEncrypted | boolean | Is Encrypted | false | O | O | O | |
| Description | string | URLEncode(Description | O | O | O | ||
| Notification | string | URLEncode(Notification) | O | O | O | ||
| Function | string | Function name | O | ||||
| Status | int | Status joined the Channel |
SubscribePTTChannel
| int SubscribePTTChannel(int ChannelID) int Subscribe(int ChannelID, string InvitationCode) | |
| ChannelID Channel ID to subscribe | |
|---|---|
| InvitationCode | If user is invited, user has the invitation code. |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Subscribe to channel |
| SDK version | 1.1.1 |
OpenPTTChannel
| int OpenPTTChannel(int ChannelID, PTTChannelEvent EventHandler) | |
| ChannelID Channel ID to open | |
|---|---|
| EventHandler | Event handler to receive events |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnChannelOpened |
| Description | Open PTT channel instance |
| SDK version | 1.1.1 |
ClosePTTChannel
| int ClosePTTChannel(PTTChannel PTTChannelInstance) | |
| PTTChannelInstance PTTChannel Instance to close | |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Description | Close PTT channel instance |
| SDK version | 1.1.1 |
OpenGroup
| int OpenGroup(int GroupID, GroupEvent EventHandler) | |
| GroupID | Group's ID to open |
|---|---|
| EventHandler | Event handler to receive events |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnGroupOpened |
| Description | Open Buddy Group |
| SDK version | 1.1.1 |
CloseGroup
| int CloseGroup(Group GroupInstance) | |
| GroupInstance | Group instance to be closed |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Description | Close Group |
| SDK version | 1.1.1 |
GetNotices
| int GetNotices(int NoticeID, int Count) | |
| NoticeID | First Notice's ID to get |
|---|---|
| Count | Count to get |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | OnNotices |
| Description | Request Notice list |
| SDK version | 1.1.1 |
AwakeUser
| int AwakeUser(string UserID) | |
| UserID | User ID to receive notify |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Request to send Awake notify |
| SDK version | 1.1.1 |
AwakeChannelUser
| int AwakeUser(int ChannelID, string UserID) | |
| ChannelID | Channel ID to request |
|---|---|
| UserID | User ID to receive notify |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Request to send Awake notify to Channel User |
| SDK version | 1.1.1 |
SetActive
| int SetActive(boolean IsActive) | |
| IsActive | Is Active |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Expected Events | |
| Description | Set app staus. default active |
| SDK version | 1.1.1 |
SetSpeakerPhone
| int SetSpeakerPhone(boolean Enable) | |
| Enable | Use speaker phone |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Description | Use speaker phone. default false |
| SDK version | 1.1.1 |
GetCameraList
| string GetCameraList() | |
| Return | camera list seperated by ',' |
|---|---|
| Expected Events | |
| Description | get camera list |
| SDK version | 1.1.1 |
SetCamera
| int SetCamera(string CameraName) | |
| CameraName | Camera Name to be used |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Expected Events | |
| Description | Use camera. default face camera |
| SDK version | 1.1.1 |
EnableBluetooth
| int EnableBluetooth(type DeviceType) | |
| DeviceType | Android, IOS : int 20:Headset, 23:Button, 29:Headset+Button Windows : string bluetooth Port Name |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Expected Events | OnBluetoothStatusChanged |
| Description | Use bluetooth device |
| SDK version | 1.1.1 |
DisableBluetooth
| int DisableBluetooth(type DeviceType) | |
| DeviceType | Android, IOS : int 20:Headset, 23:Button, 29:Headset+Button Windows : string bluetooth Port Name |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Expected Events | OnBluetoothStatusChanged |
| Description | Disable bluetooth device |
| SDK version | 1.1.1 |
SetBluetoothMode
| int SetBluetoothMode(int mode) | |
| mode | 0 : None (default) 10 : Battery Save Mode |
|---|---|
| Return | 0:Success, 0<ErrorCode |
| Expected Events | |
| Description | Change 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 version | 1.2.0 |
GetBluetoothMode
| int GetBluetoothMode() | |
| Return | 0:Success, 0<ErrorCode |
|---|---|
| Expected Events | |
| Description | Get current Bluetooth mode |
| SDK version | 1.2.0 |
StartTestVox
| int StartTestVox() | |
| Return | 0:Success, 0<ErrorCode |
|---|---|
| Description | Use bluetooth device |
| SDK version | 1.1.1 |
StopTestVox
| int StopTestVox() | |
| Return | 0:Success, 0<ErrorCode |
|---|---|
| Expected Events | |
| Description | Disable bluetooth device |
| SDK version | 1.1.1 |
OpenVideoAnnouncerChannel
| VideoChannel OpenVideoAnnouncerChannel(VideoChannelEvent EventHandler) | |
| EventHandler | Event handler to receive events |
|---|---|
| Return | Opened Video Channel's Instance |
| Expected Events | |
| Description | Open Video channel instance for announcer |
| SDK version | 1.1.1 |
OpenVideoPlayerChannel
| VideoChannel OpenVideoPlayerChannel(int VideoChannelID, VideoChannelEvent EventHandler) | |
| VideoChannelID | Video Channel's ID to join |
|---|---|
| EventHandler | Event handler to receive events |
| Return | Opened Video Channel's Instance |
| Expected Events | |
| Description | Open Video channel instance to join |
| SDK version | 1.1.1 |
CloseVideoChannel
| int OpenPTTChannel(VideoChannel VideoChannelInstance) | |
| VideoChannelInstance | Video Channel Instance to close |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Close Video channel instance |
| SDK version | 1.1.1 |
SendPrivateMessage
| int SendPrivateMessage(string ReceiverID, string Message) | |
| ReceiverID | Receiver ID to be received a message. |
|---|---|
| Message | Max 200 characters |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send Message to Receiver |
| Server version | 1.2.x~ |
| SDK version | 1.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 ) |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send a CustomMessage to Receiver. |
| Server version | 1.2.x~ |
| SDK version | 1.2.0 |
Events
OnError
| OnError(int ErrorCode, string ErrorMesssage) | |
| ErrorCode | Error code. see Main 6 |
|---|---|
| ErrorMesssage | Error message |
| Description | Errer event |
| SDK version | 1.1.1 |
OnResult
| OnResult(int Seq, int ResultCode, string ResultMesssage) | |
| Seq | Requested Sequence ID |
|---|---|
| ResultCode | Error code. see Main 7 |
| ResultMesssage | Error message |
| Description | Result event for request |
| SDK version | 1.1.1 |
OnProvisioned
| OnProvisioned(string InitialJson) | |
| InitialJson | |
|---|---|
| Description | Connected to server. |
| SDK version | 1.1.1 |
| field | type | Description | Default |
|---|---|---|---|
| UserName | string | User's name In case of guest, name is ''. | |
| NationCode | string | User's pysical location. ISO 3166-1 alpha-2 | |
| NewNotificationCount | int | Notification count after LastNotificationID | |
| LastAppVersion | string | Last App version | |
| UserEmail | string | User's email | |
| CheckedEmail | boolean | Is verified email? | false |
| ExpireTime | string | Expire Time(GMT0) , ex) 2015-05-21 20:10:12 | Unlimit |
| MinAppVersion | string | Minimum App version | 1.0.0 |
| UpgradeURL | string | "store" : app store URL : visit web | store |
| EnableVideoSharing | boolean | enable video sharing | false |
| EnablePhotoSharing | boolean | enable photo sharing | false |
| EnableGroupChannel | boolean | enable to create group PTT channel.(for Cloud/Package) | false |
| EnableDispatching | boolean | enable dispatching service for Dispatcher | false |
| EnablePush | boolean | enable push feature | false |
| RequiredLocation | boolean | enable location sending | false |
| FAQURL | string | URL : visit web | PC: http://www.proptt.com/xx/faq.htm smart device http://www.proptt.com/xx/mfaq.htm xx means language code. ex) 'en', 'ko', 'zh' |
| Homepage | string | URL : visit web | www.proptt.com |
| LogoID | int | If it is not 0 and not same with local LogoID, must download it | ProPTT logo |
OnConnected
| OnConnected() | |
| Description | Connected to server. |
|---|---|
| SDK version | 1.1.1 |
OnSetup
| OnSetup() | |
| Description | Setup to server. |
|---|---|
| SDK version | 1.1.1 |
OnDisconnected
| OnDisconnected(int Reason) | |
| Reason | Whether the session log out. 0: Network Error 1: Log-out 2: Duplicate Log-in 3: Upgrade 4: Invalid License 5: Invalid Account |
|---|---|
| Description | Disconnected to server. |
| SDK version | 1.1.1 |
OnProfileUpdated
| OnProfileUpdated(string ProfileAttributesJson) | |
| ProfileAttributesJson | Updated attributes |
|---|---|
| Description | Profile is updated. |
| SDK version | 1.1.1 |
OnProfile
| OnProfile(string ProfileAttributeJson) | |
| ProfileAttributeJson | Profile attributes |
|---|---|
| Description | Response of GetProfile. |
| SDK version | 1.1.1 |
OnProfileSearched
| OnProfileSearched(string ProfilesJson) | |
| ProfilesJson | Profile list |
|---|---|
| Description | Response of SearchProfile. |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Profile | string | O | ||
| ProfileAttributes | string | ProfileAttributesJson | M |
OnProvisionUpdated
| OnProvisionUpdated(string ProvisionAttributeJson) | |
| ProvisionAttributeJson | Updated attributes |
|---|---|
| Description | Provision is updated. |
| SDK version | 1.1.1 |
OnPresenceUpdated
| OnPresonceUpdated(string PresenceAttributesJson) | |
| PresenceAttributesJson | Attributes |
|---|---|
| Description | Presence is updated |
| SDK version | 1.1.1 |
OnPhotoUpdated
| OnPhotoUpdated(int PhotoChangeNumber) | |
| PhotoChangeNumber | Photo's change number |
|---|---|
| Description | Photo is updated |
| SDK version | 1.1.1 |
OnBuddyPhotoReceived
| OnBuddyPhotoReceived(string UserID, int PhotoType, int PhotoDataLength, byte[] PhotoDataBuffer) OnBuddyPhotoReceived(string UserID, string PhotoURL) | |
| UserID | User ID of photo |
|---|---|
| PhotoType | Photo Type (20: BMP, 31: JPEG, 32 PNG) |
| PhotoDataLength | Data size |
| PhotoDataBuffer | Buffer of data |
| PhotoURL | URL to receive photo |
| Description | Response of GetBuddyPhoto |
| SDK version | 1.1.1 |
OnChannelCreated
| OnChannelCreated(int ChannelID) | |
| ChannelID | Created Channel's ID |
|---|---|
| Description | PTTChannel is created. |
| SDK version | 1.1.1 |
OnChannelUpdated
| OnChannelUpdated(string ChannelAttributesJson) | |
| ChannelAttributesJson | Attributes |
|---|---|
| Description | PTTChannel is updated by owner. |
| SDK version | 1.1.1 |
OnChannelDeleted
| OnChannelDeleted(int ChannelID) | |
| ChannelID | Deleted Channel's ID |
|---|---|
| Description | PTTChannel is deleted. |
| SDK version | 1.1.1 |
OnChannelOpened
| OnChannelOpened(PTTChannel PTTChannelInstance) | |
| PTTChannelInstance | Opened Channel's Instance |
|---|---|
| Description | PTTChannel Instance is opened. |
| SDK version | 1.1.1 |
OnChannels
| OnChannels(string ChannelsJson) | |
| ChannelsJson | |
|---|---|
| Description | Response of GetChannels |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Channel | string | O | ||
| ChannelAttributes | string | ChannelAttributesJson | M |
OnChannel
| OnChannel(string ChannelAttributesJson) | |
| ChannelAttributesJson | |
|---|---|
| Description | Response of GetChannelInfo |
| SDK version | 1.1.1 |
OnChannelSearched
| OnChannelSearched(string ChannelsJson) | |
| ChannelsJson | Channel list |
|---|---|
| Description | Response of SearchChannel. |
| SDK version | 1.1.1 |
OnMembers
| OnMembers(string MembersJson) | |
| MembersJson | result(Json) |
|---|---|
| Description | Response of GetMembers |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Member | O | |||
| UserID | string | Member’s ID | M | |
| Name | string | URLEncode(Member’s name) | M | |
| JoinedChannel | O | |||
| ChannelID | string | Joined Channel ID | M | |
| WaitedChannel | O | |||
| ChannelID | string | Waited ChannelLID | M | |
| InvitorID | string | M | ||
| InvitorName | string | M |
OnGroupOpened
| OnGroupCreated(Group GroupInstance) | |
| GroupInstance | Opened Group's Instance |
|---|---|
| Description | Group Instance is opened. |
| SDK version | 1.1.1 |
OnGroups
| OnGroups(string GroupsJson) | |
| GroupsJson | |
|---|---|
| Description | Response of GetGroups |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Group | O | |||
| ID | int | Group’s ID | M | |
| Name | string | URLEncode(Group's Name) | M | |
| Type | int | 0:Normal | M |
OnBuddies
| OnResponseBuddies(string BuddiesJson) | |
| BuddiesJson | result(Json) |
|---|---|
| Description | Response of GetBuddies |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Buddy | O | |||
| UserLID | string | Buddy ID | M | |
| UserName | string | Buddy Name | M | |
| GroupID | int | Group ID | M | |
| Status | int | 10: registed, 20: requesting: 30: accepted |
OnOrganizations
| OnOrganizations(string OrganizationsJson) | |
| OrganizationsJson | |
|---|---|
| Description | Response of GetOrganizations |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Organization | O | |||
| ID | int | Organization’s ID | M | |
| Name | string | URLEncode(Organization's Name) | M | |
| Type | int | 0:Normal | M |
OnUsers
| OnUsers(string UsersJson) | |
| UsersJson | result(Json) |
|---|---|
| Description | Response of GetUsers |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| User | O | |||
| UserLID | string | User's ID | M | |
| UserName | string | User's Name | M | |
| IncludedGroups | O | |||
| OrganizationID | int | Organization’s ID | M |
OnBuddyRequested
| OnBuddyRequested(int GroupID, string RequesterID, string RequesterName) | |
| GroupID | Group ID of event |
|---|---|
| RequesterID | User ID who have added me |
| RequesterName | User Name who have added me |
| Description | Response of GetUsers |
| SDK version | 1.1.1 |
OnBuddyAccepted
| OnBuddyAccepted(int GroupID, string UserID) | |
| GroupID | Group ID of event |
|---|---|
| UserID | Subscriber's ID |
| Description | Subscribed into a Buddy Group |
| SDK version | 1.1.1 |
OnBuddyDenied
| OnBuddyDenied(int ChannelID, string UserID) | |
| GroupID | Group ID of event |
|---|---|
| UserID | Subscriber's ID |
| Description | User is joined into a Buddy Group |
| SDK version | 1.1.1 |
OnSubscribeRequested
| OnSubscribeRequested(int ChannelID, string MemberID, string MemberName) | |
| ChannelID | Channel ID of event |
|---|---|
| MemberID | Subscriber's ID |
| MemberName | Subscriber's Name |
| Description | Requested a subscription into a PTT channel. |
| SDK version | 1.1.1 |
OnSubscribeAccepted
| OnSubscribeAccepted(int ChannelID, string MemberID, string MemberName) | |
| ChannelID | Channel ID of event |
|---|---|
| MemberID | Subscriber's ID |
| MemberName | Subscriber's Name |
| Description | Subscribed into a PTT channel |
| SDK version | 1.1.1 |
OnSubscribeDenied
| OnSubscribeDenied(int ChannelID, string MemberID) | |
| ChannelID | Channel ID of event |
|---|---|
| MemberID | Subscriber's ID |
| Description | User is joined into a PTT channel. |
| SDK version | 1.1.1 |
OnUnsubscribed
| OnUnsubscribed(int ChannelID, string MemberID, string OwnerID) | |
| ChannelID | Channel ID of event |
|---|---|
| MemberID | Unsubscriber's ID |
| OwnerID | Channel owner's ID |
| Description | User is joined into a PTT channel. |
| SDK version | 1.1.1 |
OnSubscribeCanceled
| OnSubscribeCanceled(int ChannelID, string MemberID) | |
| ChannelID | Channel ID of event |
|---|---|
| MemberID | Requester's ID for cancel |
| Description | Canceled to subscribe |
| SDK version | 1.1.1 |
OnInviteRequested
| OnInviteRequested(int ChannelID, string channelName, string RequesterID, string RequesterName, string ReceiverID, string ReceiverName) | |
| ChannelID | Channel ID of event |
|---|---|
| ChannelName | Channel Name |
| RequesterID | Requester ID |
| RequesterName | Requester Name |
| ReceiverID | Receiver ID |
| ReceiverName | Receiver Name |
| Description | Invited from another peer |
| SDK version | 1.1.1 |
OnInviteAccepted
| OnInvitedAccepted(int ChannelID, string SenderID, string ReceiverID, string ReceiverName) | |
| ChannelID | Channel ID of event |
|---|---|
| SenderID | Sender ID |
| ReceiverID | Receiver ID |
| ReceiverName | Receiver Name |
| Description | accepted to invite PTT channel |
| SDK version | 1.1.1 |
OnInviteDenied
| OnInvitedDenied(int ChannelID, string RequesterID, string ReceiverID, string ReceiverName) | |
| ChannelID | Channel ID of event |
|---|---|
| RequesterID | Requester ID |
| ReceiverID | Receiver ID |
| Description | denied to invite PTT channel |
| SDK version | 1.1.1 |
OnInviteCanceled
| OnInvitedCanceled(int ChannelID, string ReceiverID) | |
| ChannelID | Channel ID of event |
|---|---|
| ReceiverID | Receiver ID |
| Description | Canceled to invite |
| SDK version | 1.1.1 |
OnNotices
| OnNotices(string NoticesJson) | |
| ChannelsJson | |
|---|---|
| Description | Response of GetNotices |
| SDK version | 1.1.1 |
| field | type | Description | Default | R |
|---|---|---|---|---|
| Notice | O | |||
| Id | int | Notice ID | M | |
| Title | string | Title of Notice | M | |
| Content | string | Content of Notice | M | |
| Type | int | 10: Normal | M | |
| UpdateDate | string | Date to update Notice | M |
OnAwakeUser
| OnAwakeUser(string UserID) | |
| UserID | User ID to receive notify |
|---|---|
| Description | Response of AwakeUser |
| SDK version | 1.1.1 |
OnAwakeChannelUser
| OnAwakeChannelUser(int ChannelID, string UserID) | |
| ChannelID | Channel ID of event |
|---|---|
| UserID | User ID to receive notify |
| Description | Response of AwakeChannelUser |
| SDK version | 1.1.1 |
OnBluetoothStatusChanged
| OnBluetoothStatusChanged(int BluetoothStatus) | |
| BluetoothStatus | 0: Unavailable, 10:Available, 20:Headset Enabled, 23:Button Enabled, 29:Headset+Button Enabled |
|---|---|
| Description | Bluetooth device's status is changed |
| SDK version | 1.1.1 |
OnVoxDataCaptured
| OnVoxDataCaptured(byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp) | |
| TrackDataBuffer | Buffer of data |
|---|---|
| DataLength | Data size |
| Timestamp | Timestamp of data |
| Description | Vox data is captured from device. |
| SDK version | 1.1.1 |
