Home Units Hierarchy Routines All identifiers

Class unaConfRTProom

DescriptionHierarchyFieldsMethodsProperties

Unit

unaConfRTPserver

Declaration

type unaConfRTProom = class(unaObject)

Description

RTP Conference room

Hierarchy

Overview

Methods

Public constructor create(srv: TunaConfRTPserver; const roomName: wString; roomID: tRoomID = -1);
Public destructor Destroy(); override;
Public function dropUser(userID: u_int32): bool;
Public function hasUser(userID: u_int32): bool;
Public function userByIndexAcquire(index: int; ro: bool = true; timeout: tTimeout = 100): unaConfRTProomUser;
Protected function addUser(userID: u_int32): int;
Public procedure announce(const msg: wString);

Properties

Public property bwIn: int read f_bwIn;
Public property bwOut: int read f_bwOut;
Public property closed: bool read f_closed;
Public property roomID: tRoomID read f_roomID;
Public property roomName: wString read f_roomName;
Public property userCount: int read getCC;

Description

Methods

Public constructor create(srv: TunaConfRTPserver; const roomName: wString; roomID: tRoomID = -1);

Creates a new room.

Public destructor Destroy(); override;

Destroys room.

Public function dropUser(userID: u_int32): bool;

Removes user from this room.

Parameters
userID
user ID
Returns

True if user was found and removed from room seats

Public function hasUser(userID: u_int32): bool;

Locates user in room.

Parameters
userID
user ID
Returns

True if user with specified ID is listed in this room.

Public function userByIndexAcquire(index: int; ro: bool = true; timeout: tTimeout = 100): unaConfRTProomUser;

Locates user in room.

Parameters
index
user index (from 0 to userCount - 1)
ro
Indicates access level to user object, true means read-only
timeout
timeout
Returns

Acquired user object or nil. Object must be released with .release() when it is no longer needed.

Protected function addUser(userID: u_int32): int;

Returns index.

Public procedure announce(const msg: wString);

Sends some message to all clients in the room.

Parameters
msg
Text to be announced.

Properties

Public property bwIn: int read f_bwIn;

Incoming bandwidth.

Public property bwOut: int read f_bwOut;

Outgoing bandwidth.

Public property closed: bool read f_closed;

True if room is closed. Use srv.roomStartup() / srv.roomShutdown to open/close the room.

Public property roomID: tRoomID read f_roomID;

Room ID.

Public property roomName: wString read f_roomName;

Room Name.

Public property userCount: int read getCC;

Number of users.

(c) 2012 Lake of Soft

Generated by PasDoc 0.12.1 on 2012-10-09