Skip to content

Commit

Permalink
udpate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
huangminlinux committed Sep 19, 2018
1 parent 92a5450 commit 38f8d71
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion document/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
- [CallUserVideoStreamEnabled](#calluservideostreamenabled)


[Model](model)

- [Session](session)

## Common API

### initEngine
Expand Down Expand Up @@ -359,4 +363,36 @@ const handler = (res) => {
JMRTCViewController.addCallUserVideoStreamEnabledListener(handler)
// 移除监听
JMRTCViewController.removeListener(handler)
```
```
## Model

### Session

```json
userModel = {
type: 'user',
username: string, // 用户名
appKey: string, // 用户所属应用的 appKey,可与 username 共同作为用户的唯一标识
nickname: string, // 昵称
gender: string, // 'male' / 'female' / 'unknown'
avatarThumbPath: string, // 头像的缩略图地址
birthday: number, // 日期的毫秒数
region: string, // 地区
signature: string, // 个性签名
address: string, // 具体地址
noteName: string, // 备注名
noteText: string, // 备注信息
isNoDisturb: boolean, // 是否免打扰
isInBlackList: boolean, // 是否在黑名单中
isFriend:boolean // 是否为好友
}
session = {
channelId: string,
mediaType: "video" | "voice",
inviter: userModel,
invitingMembers: [userModel],
joinedMembers: [userModel],
startTime: number
}
```

0 comments on commit 38f8d71

Please sign in to comment.