99class AppClient
1010{
1111 private $ auth ;
12- private $ _baseURL ;
12+ private $ baseURL ;
1313
1414 public function __construct (Auth $ auth )
1515 {
1616 $ this ->auth = $ auth ;
1717
18- $ this ->_baseURL = sprintf ("%s/%s/apps " , Config::RTCAPI_HOST , Config::RTCAPI_VERSION );
18+ $ this ->baseURL = sprintf ("%s/%s/apps " , Config::RTCAPI_HOST , Config::RTCAPI_VERSION );
1919 }
2020
2121 /*
2222 * hub: 直播空间名
2323 * title: app 的名称 注意,Title 不是唯一标识,重复 create 动作将生成多个 app
2424 * maxUsers:人数限制
25- * NoAutoKickUser: bool 类型,可选,禁止自动踢人(抢流)。默认为 false ,即同一个身份的 client (app/room/user) ,新的连麦请求可以成功,旧连接被关闭。
25+ * NoAutoKickUser: bool 类型,可选,禁止自动踢人(抢流)。默认为 false ,
26+ 即同一个身份的 client (app/room/user) ,新的连麦请求可以成功,旧连接被关闭。
2627 */
2728 public function createApp ($ hub , $ title , $ maxUsers = null , $ noAutoKickUser = null )
2829 {
@@ -35,7 +36,7 @@ public function createApp($hub, $title, $maxUsers = null, $noAutoKickUser = null
3536 $ params ['noAutoKickUser ' ] = $ noAutoKickUser ;
3637 }
3738 $ body = json_encode ($ params );
38- $ ret = $ this ->post ($ this ->_baseURL , $ body );
39+ $ ret = $ this ->post ($ this ->baseURL , $ body );
3940 return $ ret ;
4041 }
4142
@@ -56,7 +57,7 @@ public function createApp($hub, $title, $maxUsers = null, $noAutoKickUser = null
5657 */
5758 public function updateApp ($ appId , $ hub , $ title , $ maxUsers = null , $ mergePublishRtmp = null , $ noAutoKickUser = null )
5859 {
59- $ url = $ this ->_baseURL . '/ ' . $ appId ;
60+ $ url = $ this ->baseURL . '/ ' . $ appId ;
6061 $ params ['hub ' ] = $ hub ;
6162 $ params ['title ' ] = $ title ;
6263 if (!empty ($ maxUsers )) {
@@ -78,7 +79,7 @@ public function updateApp($appId, $hub, $title, $maxUsers = null, $mergePublishR
7879 */
7980 public function getApp ($ appId )
8081 {
81- $ url = $ this ->_baseURL . '/ ' . $ appId ;
82+ $ url = $ this ->baseURL . '/ ' . $ appId ;
8283 $ ret = $ this ->get ($ url );
8384 return $ ret ;
8485 }
@@ -88,7 +89,7 @@ public function getApp($appId)
8889 */
8990 public function deleteApp ($ appId )
9091 {
91- $ url = $ this ->_baseURL . '/ ' . $ appId ;
92+ $ url = $ this ->baseURL . '/ ' . $ appId ;
9293 list (, $ err ) = $ this ->delete ($ url );
9394 return $ err ;
9495 }
@@ -100,7 +101,7 @@ public function deleteApp($appId)
100101 */
101102 public function listUser ($ appId , $ roomName )
102103 {
103- $ url = sprintf ("%s/%s/rooms/%s/users " , $ this ->_baseURL , $ appId , $ roomName );
104+ $ url = sprintf ("%s/%s/rooms/%s/users " , $ this ->baseURL , $ appId , $ roomName );
104105 $ ret = $ this ->get ($ url );
105106 return $ ret ;
106107 }
@@ -113,7 +114,7 @@ public function listUser($appId, $roomName)
113114 */
114115 public function kickUser ($ appId , $ roomName , $ userId )
115116 {
116- $ url = sprintf ("%s/%s/rooms/%s/users/%s " , $ this ->_baseURL , $ appId , $ roomName , $ userId );
117+ $ url = sprintf ("%s/%s/rooms/%s/users/%s " , $ this ->baseURL , $ appId , $ roomName , $ userId );
117118 list (, $ err ) = $ this ->delete ($ url );
118119 return $ err ;
119120 }
@@ -126,22 +127,22 @@ public function kickUser($appId, $roomName, $userId)
126127 * limit: int 类型,此次查询的最大长度。
127128 * GET /v3/apps/<AppID>/rooms?prefix=<RoomNamePrefix>&offset=<Offset>&limit=<Limit>
128129 */
129- public function listRooms ($ appId , $ prefix = null , $ offset = null , $ limit = null )
130+ public function listActiveRooms ($ appId , $ prefix = null , $ offset = null , $ limit = null )
130131 {
131- if (isset ($ prefix )){
132+ if (isset ($ prefix )) {
132133 $ query ['prefix ' ] = $ prefix ;
133134 }
134- if (isset ($ offset )){
135+ if (isset ($ offset )) {
135136 $ query ['offset ' ] = $ offset ;
136137 }
137- if (isset ($ limit )){
138+ if (isset ($ limit )) {
138139 $ query ['limit ' ] = $ limit ;
139140 }
140141 if ($ query != null ) {
141142 $ query = '? ' . http_build_query ($ query );
142- $ url = sprintf ("%s/%s/rooms%s " , $ this ->_baseURL , $ appId , $ query );
143+ $ url = sprintf ("%s/%s/rooms%s " , $ this ->baseURL , $ appId , $ query );
143144 } else {
144- $ url = sprintf ("%s/%s/rooms " , $ this ->_baseURL , $ appId );
145+ $ url = sprintf ("%s/%s/rooms " , $ this ->baseURL , $ appId );
145146 }
146147 $ ret = $ this ->get ($ url );
147148 return $ ret ;
@@ -151,14 +152,16 @@ public function listRooms($appId, $prefix = null, $offset = null, $limit = null)
151152 * appId: app 的唯一标识,创建的时候由系统生成。
152153 * roomName: 房间名称,需满足规格 ^[a-zA-Z0-9_-]{3,64}$
153154 * userId: 请求加入房间的用户 ID,需满足规格 ^[a-zA-Z0-9_-]{3,50}$
154- * expireAt: int64 类型,鉴权的有效时间,传入以秒为单位的64位Unix绝对时间,token 将在该时间后失效。
155- * permission: 该用户的房间管理权限,"admin" 或 "user",默认为 "user" 。当权限角色为 "admin" 时,拥有将其他用户移除出房间等特权.
155+ * expireAt: int64 类型,鉴权的有效时间,传入以秒为单位的64位Unix
156+ 绝对时间,token 将在该时间后失效。
157+ * permission: 该用户的房间管理权限,"admin" 或 "user",默认为 "user" 。
158+ 当权限角色为 "admin" 时,拥有将其他用户移除出房间等特权.
156159 */
157160 public function appToken ($ appId , $ roomName , $ userId , $ expireAt , $ permission )
158161 {
159162 $ params ['appId ' ] = $ appId ;
160163 $ params ['userId ' ] = $ userId ;
161- $ params ['roomName ' ] = $ roomName ;
164+ $ params ['roomName ' ] = $ roomName ;
162165 $ params ['permission ' ] = $ permission ;
163166 $ params ['expireAt ' ] = $ expireAt ;
164167 $ appAccessString = json_encode ($ params );
0 commit comments