Reference of PTTChannel
Description of PTTChannel
PTTClient Group VideoChannelPTTChannel Class
| name | type | attributes | description |
|---|---|---|---|
| channelID | int | readonly | Channel ID |
| channelNo | string | readonly | Channel number |
| channelName | string | readonly | Channel name |
| channelDescription | string | readonly | Channel description |
| channelNotification | string | readonly | Channel notification |
| TOT | int | readonly | Time Out Timer, second |
| recordable | boolean | readonly | Is a recordable channel. Client app can save PTTs on device. An administrator can select it on adminWeb. |
| encrypted | boolean | readonly | Is a encrypted channel. PTT data is encrypted. An administrator can select it on adminWeb. |
| shareLocations | boolean | readonly | Member's locations cab be shared in a channel. An administrator can select it on adminWeb. (Android, Windows) |
| ownerID | string | readonly | Channel Owner ID |
| ownerName | string | readonly | Channel Owner Name |
| function | string | readonly | Function Key names |
| type | string | readonly | Channel Type 'G'roup,'1':1 |
| status | int | readonly | Status joined the Channel 10: Invited, 20:request subscribe, 30: subscribed |
| foreground | boolean | Channel's focus status | |
| useVox | boolean | Whether to use vox for lock. It can work when this channel is on foreground and enableInternalLock is enabled. Please check them. | |
| useBluetooth | boolean | Whether to use bluetooth for lock. It can work when this channel is on foreground and enableInternalLock is enabled. Please check them. | |
| enableInternalLock | boolean | Whether to use internal lock by bluetooth or VOX. default is true. | |
| lockMediaProfileID | int | Media Profile ID when locked Belows are defined as constant. PROFILE_ID_OPUS8_ONLY_VBR : Audio PTT VBR(Low) PROFILE_ID_OPUS8_ONLY : Audio PTT(Middle) PROFILE_ID_OPUS16_ONLY : Audio PTT(High) PROFILE_ID_OPUS8_MJPEG_LOW : Video PTT(Low) PROFILE_ID_OPUS8_MJPEG_MID : Video PTT(Middle) PROFILE_ID_OPUS8_MJPEG_HIGH : Video PTT(High) PROFILE_ID_OPUS16_MJPEG_LOW : Video PTT(Low) PROFILE_ID_OPUS16_MJPEG_MID : Video PTT(Middle) PROFILE_ID_OPUS16_MJPEG_HIGH : Video PTT(High) | |
| peerLockMediaProfileID | int | Media Profile ID when locked Uppers are defined as constant.(Android) | |
| lockStatus | int | readonly |
Status for PTT lock 0 : unlocked 1 : request unlock 2 : request lock 3 : locked by me 4 : locked by someone |
| joinStatus | int | readonly |
Status for channel join 0 : leaved 1 : joined |
| playAmplification | int | -50~100, default 0 | |
| enablePlayAudio | boolean | Audio play status | |
| enableSendAudio | boolean | Audio send status | |
| enablePlayVideo | boolean | Video play status | |
| enableSendVideo | boolean | Video send status | |
| playVolume | int | 0~100 (Windows only) |
Methods
deleteChannel
| int deleteChannel() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | onChannelDeleted |
| Description | Delete PTT channel. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
updateChannel
| int updateChannel(string ChannelAttributesJson) | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | onChannelUpdated |
| Description | Update PTT channel informations. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
join
| int join() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | onJoined() |
| Description | Start PTT channel |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
leave
| int leave() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | onLeaved |
| Description | Stop PTT channel |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
acceptSubscribe
| int acceptSubscribe(string RequesterID, string RequesterName) | |
| RequesterID | Requester's ID |
|---|---|
| RequesterName | Requester's Name |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Accept requester's subscription. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
denySubscribe
| int denySubscribe(string RequesterID, string RequesterName) | |
| RequesterID | Requester's ID |
|---|---|
| RequesterName | Requester's Name |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Deny requester's subscription. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
unsubscribe
| int unsubscribe() int unsubscribe(string UnsubscribedID) | |
| UnsubscribedID | ID to be unsubscribed (Android only) |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Unsubscribe to channel. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
cancelSubscribe
| int cancelSubscribe() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | |
| Description | Request Cancel of subscribe to channel. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
invite
| int invite(string ReceiverID) | |
| ReceiverID | Receiver ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Invite Receiver. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
acceptInvite
| int acceptInvite(string RequesterID) | |
| ReceiverID | Requester's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Response of PTTClient's invitation. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
denyInvite
| int denyInvite(string RequesterID) | |
| ReceiverID | Requester's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Response of PTTClient's invitation. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
cancelInvite
| int cancelInvite(string RequesterID) | |
| RequesterID | Requester's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Request Cancel of invite. This method is for only app srvice. You can not use it for server package and cloud service. Don't use it. System could be broken. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
lockPTT
| int lockPTT() int lockPTT(boolean Emergency) | |
| Emergency | If other user have a lock, break the lock and make a new lock for user |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onLocked |
| Description | Request Channel lock to server |
| SDK version | 1.1.1, Lock(boolean Emergency) is in 1.2.0 |
unlockPTT
| int unlockPTT() | |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
|---|---|
| Expected Events | onUnlocked |
| Description | Request Channel unlock to server |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
sendPublicMessage
| int sendPublicMessage(string Message) | |
| Message | Max 200 characters |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send a Message to all in same PTTChannel. Notice: Message's sequence is not guaranteed. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
sendPrivateMessage
| int sendPrivateMessage(string ReceiverID, string Message) | |
| ReceiverID | Receiver ID |
|---|---|
| Message | Max 200 characters |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send a Private Message to Receiver. Notice: Message's sequence is not guaranteed. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
sendPublicCustomMessage
| int sendPublicCustomMessage(byte[] DataBuffer, int DataLength) | |
| DataBuffer | Buffer of data |
|---|---|
| DataLength | Data size. Max size is 30KB. |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send a CustomMessage to all. Notice: Message's sequence is not guaranteed. |
| Server version | 1.2.x~ |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
sendPrivateCustomMessage
| int sendPrivateCustomMessage(string ReceiverID, byte[] DataBuffer, int DataLength) | |
| ReceiverID | Receiver ID |
|---|---|
| DataBuffer | Buffer of data |
| DataLength | Data size. Max size is 30KB. |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | |
| Description | Send a CustomMessage to Receiver. Notice: Message's sequence is not guaranteed. |
| Server version | 1.2.x~ |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
callFunction
| int callFunction(string FunctionName, string Parameter) | |
| FunctionName | Function's Name |
|---|---|
| Parameter | Function's Parameter |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onCallFunction |
| Description | Call channel's function |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
shareVideo
| int shareVideo(int VideoChannelID) int shareVideo(int videoChannelID,const char* serverIP, int port, bool useSSL, const char* cmToken, const char* protocol) | |
| VideoChannelID | Shared VideoChannel's ID |
|---|---|
| serverIP | Shared video source's IP. (Windows only) |
| port | Shared video source's port. (Windows only) |
| useSSL | Shared video source's ssl usage. (Windows only) |
| cmToken | Shared video source's authentication token. (Windows only) |
| protocol | Shared video source's protocol. "IMPTTP", (Windows only) |
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onVideoShared |
| Description | Share video with members |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
unshareVideo
| int unshareVideo(int VideoChannelID) | |
| VideoChannelID | Unshared VideoChannel's ID |
|---|---|
| Return | Request Sequence ID. If less then 0, ErrorCode. |
| Expected Events | onVideoUnshared |
| Description | Unshare video with members |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
setCameraPreview
| int setCameraPreview(View Preview) int setCameraPreview(View Preview, View Preview2) | |
| Preview | Camera Preview ios : UIView* android : SurfaceView window : HWND(C++),IntPtr(C#) |
|---|---|
| Preview2 | Camera Preview android : SurfaceView, it is for Video quality |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
| Sample(Android) | In Layout, <SurfaceView android:id="@+id/surface_preview" android:layout_width="match_parent" android:layout_height="match_parent" /> In Code, SurfaceView surfacePreview = (SurfaceView) findViewById(R.id.surface_preview); channel.setCameraPreview(surfacePreview); channel.startPreview(); |
| Sample(C#) | var wih = new WindowInteropHelper(window); IntPtr hWnd = wih.Handle; channel.SetVideoWindow(hWnd); |
setPlayView
| int setPlayView(View PlayView) | |
| PlayView | Video PlayView ios : UIView* android : com.imptt.propttsdk.media.view.VideoView window : HWND(C++),IntPtr(C#) |
|---|---|
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
| Sample(Android) | In Layout, <com.imptt.propttsdk.media.view.VideoView android:id="@+id/surface_play_video" android:layout_width="match_parent" android:layout_height="match_parent" /> In Code, VideoView shareVideoPlayView = (VideoView) findViewById(R.id.surface_play_video); channel.setPlayView(shareVideoPlayView); |
| Sample(C#) | var wih = new WindowInteropHelper(window); IntPtr hWnd = wih.Handle; channel.SetVideoWindow(hWnd); |
setAudioManager
| void setAudioManager(IAudioManager AudioManager) | |
| AudioManager | AudioManager instance |
|---|---|
| Description | Can use for external audio devices Please refer to IAudioManager. |
| Android SDK | 2.1.1(Capturer only) |
| iOS SDK | 2.1.1(But not tested) |
| Windows SDK | Not supported |
| Linux SDK | Not supported yet |
getLocations
| int getLocations(string LastSearchedDate) | |
| LastSearchedDate | Location will be searched after LastSearchedDate. if it is "", All. "yyyy-MM-dd HH:mm:ss", GMT0 |
|---|---|
| Description | Search member's location. |
| Expected Events | onLocations |
| Server version | 3.2.1~ |
| Android SDK | 2.1.3 |
| iOS SDK | Not supported |
| Windows SDK | Not supported |
| Linux SDK | Not supported yet |
Events
onPTTChannelError
| void onPTTChannelError(PTTChannel ChannelInstance, int ErrorCode, string ErrorMesssage) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| ErrorCode | Error code. see Main 6 |
| ErrorMesssage | Error message |
| Description | Errer event |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onPTTChannelResult
| void onPTTChannelResult(PTTChannel ChannelInstance,int Seq, int ResultCode, string ResultMesssage) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| Seq | Requested Sequence ID |
| ResultCode | Error code. see Main 7 |
| ResultMesssage | Error message |
| Description | Result event for request |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onJoined
| void onJoined(PTTChannel ChannelInstance, string MemberJson,int TotalUserCount) void onJoined(PTTChannel ChannelInstance, string MemberID, string MemberName, int TotalUserCount) | |
| ChannelInstance | Channel instance of event |
|---|---|
| MemberJson | Joined Member ID JsonArray |
| MemberID | Joined Member's ID |
| MemberName | Joined Member's Name for a guest |
| TotalUserCount | Total user count in channel |
| Description | User is joined into a PTT channel. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onLeaved
| void onLeaved(PTTChannel ChannelInstance, string MemberID) | |
| ChannelInstance | Channel instance of event |
|---|---|
| MemeberID | Leaved Member's ID |
| Description | User is leaved from a PTT channel |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onNotifyReceived
| void onNotifyReceived(PTTChannel ChannelInstance, int NotifiedCode, string NotifiedData) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| NotifiedCode | Notified code |
| NotifiedData | Notified data |
| Description | Notified from server. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onPublicMessageReceived
| void onPublicMessageReceived(PTTChannel ChannelInstance, string SenderID, string SenderName, string Message) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| SenderID | Sender ID |
| SenderName | Sender Name |
| Message | Message |
| Description | A public message is received from sender |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
OnPrivateMessageReceived
| void onPrivateMessageReceived(PTTChannel ChannelInstance, string SenderID, string SenderName, string Message) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| SenderID | Sender ID |
| SenderName | Sender Name |
| Message | Message |
| Description | A private message is received from sender. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onLocked
| void onLocked(PTTChannel ChannelInstance, string Location, unsigned int MediaProfileID, string LockerID, string LockerName) | |
| ChannelInstance | Channel instance of event |
|---|---|
| Location | Locked user's location. If "", unknown |
| MediaProfileID | |
| LockerID | Locker's ID |
| LockerName | Locker's Name for a guest |
| Description | Channel is locked by me or peer. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onUnlocked
| void onUnlocked(PTTChannel ChannelInstance, string LockerID) | |
| ChannelInstance | Channel instance of event |
|---|---|
| LockerID | Locker's ID |
| Description | Channel is unlocked by me or peer. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onTrackDataCaptured
| void onTrackDataCaptured(PTTChannel ChannelInstance, int TrackType, byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| TrackType | 0:Audio, 1:Video, 1>Others |
| TrackDataBuffer | Buffer of data. Video: no event Audio: RAW, 1 frame |
| DataLength | Data size |
| Timestamp | Timestamp of data |
| Description | Track data is captured from device. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onTrackDataEncoded
| void onTrackDataEncoded(PTTChannel ChannelInstance, int TrackType, byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| TrackType | 0:Audio, 1:Video, 1>Others |
| TrackDataBuffer | Buffer of data. Video: JPEG, 1 frame Audio: OPUS, 1 frame |
| DataLength | Data size |
| Timestamp | Timestamp of data |
| Description | Track data is encoded by encoder. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onTrackDataReceived
| void onTrackDataReceived(PTTChannel ChannelInstance, int TrackType, byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| TrackType | 0:Audio, 1:Video, 1>Others |
| TrackDataBuffer | Buffer of data. Video: JPEG, 1 frame Audio: OPUS, 1 frame |
| DataLength | Data size |
| Timestamp | Timestamp of data |
| Description | Track data is received from server. If you save the PTT, you can wite this frame into Opus or your defined file. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onTrackDataRendered
| void onTrackDataRendered(PTTChannel ChannelInstance, int TrackType, byte[] TrackDataBuffer, int DataLength, unsigned int Timestamp) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| TrackType | 0:Audio, 1:Video, 1>Others |
| TrackDataBuffer | Buffer of data. Video: no event Audio: RAW, 1 frame |
| DataLength | Data size |
| Timestamp | Timestamp of data |
| Description | Track data is rendered to device. If you save the PTT, you can wite this frame into wave file. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onPublicCustomMessageReceived
| void onPublicCustomMessageReceived(PTTChannel ChannelInstance, string SenderID, string SenderName, byte[] DataBuffer, int DataLength) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| SenderID | Sender ID |
| SenderName | Sender Name |
| DataBuffer | Buffer of data |
| DataLength | Data size |
| Description | Public custom message is received. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onPrivateCustomMessageReceived
| void onPrivateCustomMessageReceived(PTTChannel ChannelInstance, string SenderID, string SenderName, byte[] DataBuffer, int DataLength) | |
| ChannelInstance | PTTChannel instance of event |
|---|---|
| SenderID | Sender ID |
| SenderName | Sender Name |
| DataBuffer | Buffer of data |
| DataLength | Data size |
| Description | Private custom message is received. |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onVideoShared
| void onVideoShared(PTTChannel ChannelInstance, int VideoChannelID, int MediaProfileID, string VideoUploader) | |
| ChannelInstance | Channel instance of event |
|---|---|
| VideoChannelID | Shared VideoChannel's ID |
| MediaProfileID | Video Profile ID |
| VideoUploader | Uploader ID |
| Description | Video channel is shared |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onVideoUnshared
| void onVideoUnshared(PTTChannel ChannelInstance, int VideoChannelID, string VideoUploader) | |
| ChannelInstance | Channel instance of event |
|---|---|
| VideoChannelID | Unshared VideoChannel's ID |
| VideoUploader | Uploader ID |
| Description | Video channel is unshared |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onCallFunction
| void onCallFunction(PTTChannel ChannelInstance,int FunctionID, string Parameter, string SenderID, string SenderName, string Location) | |
| ChannelInstance | Channel instance of event |
|---|---|
| FunctionID | 1:SOS |
| Parameter | Function's Parameter |
| SenderID | Sender's ID |
| SenderName | Sender's Name |
| Location | user's location. If "", unknown |
| Description | Call function received |
| Server version | 1.4.x~ |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onAlert
| void onAlert(PTTChannel ChannelInstance,string SenderID, string SenderName, int Type, string Message) | |
| ChannelInstance | Channel instance of event |
|---|---|
| SenderID | Sender's ID |
| SenderName | Sender's Name |
| Type | 0:Normal |
| Message | message |
| Description | Alert received |
| Server version | 1.4.x~ |
| Android SDK | 2.1.1 |
| iOS SDK | 2.1.1 |
| Windows SDK | 2.1.1 |
| Linux SDK | Not supported yet |
onLocations
| void onLocations(PTTChannel ChannelInstance,string locationsJson) | |
| ChannelInstance | Channel instance of event |
|---|---|
| locationsJson | message |
| Description | Member's location received |
| Server version | 3.2.1~ |
| Android SDK | 2.1.2 |
| iOS SDK | Not supported |
| Windows SDK | Not supported |
| Linux SDK | Not supported yet |
| field | type | Description | Default | R |
|---|---|---|---|---|
| SearchedDate | string | Current SearchDate, yyyy-MM-dd HH:mm:ss(GMT 0) | M | |
| Buddy | O | |||
| UserID | string | User ID | M | |
| UserName | string | Member Name | M | |
| Latitude | string | Latitude | M | |
| Longitude | string | Longitude | M | |
| UpdateDate | string | Updated datetime |