|
MumbleKit
|
#import <MumbleKit/MKUser.h>
Instance Methods | |
| (NSInteger) | - userId |
| (NSUInteger) | - session |
| (NSString *) | - userName |
| Returns the user's username. | |
| (NSString *) | - userHash |
| (MKTalkState) | - talkState |
| Returns the user's current talk state. See MKTalkState for more information. | |
| (BOOL) | - isAuthenticated |
| Returns whether or not the user is authenticated. | |
| (BOOL) | - isFriend |
| Returns whether or not the receiving user is a friend. | |
| (BOOL) | - isMuted |
| Returns whether or not the receiving user is muted. | |
| (BOOL) | - isDeafened |
| Returns whether or not the receiving user is deafened. | |
| (BOOL) | - isSuppressed |
| Returns whether or not the receiving user is suppressed by the server. | |
| (BOOL) | - isLocalMuted |
| Returns whether or not the receiving user is muted by the local client. | |
| (BOOL) | - isSelfMuted |
| Returns whether or not the receiving user is self-muted. | |
| (BOOL) | - isSelfDeafened |
| Returns whether or not the receiving user is self-deafened. | |
| (BOOL) | - isPrioritySpeaker |
| Returns whether or not the receiving user has the priority speaker flag. | |
| (BOOL) | - isRecording |
| Returns whether or not the receiving user has the recording flag. | |
| (MKChannel *) | - channel |
| Returns the channel that the receiving user is currently residing in. | |
| (NSData *) | - commentHash |
| Returns the server's hash of the contents of the user's current comment. | |
| (NSString *) | - comment |
| Return the user's current comment as an NSString. | |
| (NSData *) | - textureHash |
| Returns the server's hash of the user's current texture. | |
| (NSData *) | - texture |
MKUser represents a user on a Mumble server. A user always resides in a channel, which is represented by the MKChannel object. MKChannel objects are owned by their respective MKServerModel instances.
The object's MKServerModel may change properties of the user at any time, but all changes are serialized to the main thread.
Generally, as a consumer of this API, most accesses to MKUser happen in response to MKServerModelDelegate callbacks, and all calls to delegate methods of MKServerModel are ensured to happen on the same thread that modifies MKChannle objects.
Thus, if all inspection of the MKChannel's properties happen in response to MKServerModelDelegate callbacks, everything should be OK.
| - (NSUInteger) session |
Returns the user's session ID. The session ID is mostly an implementation detail – it is an identifier that uniquely identifies a user on a server, regardless of whether or not that user is registered with the server.
| - (NSData *) texture |
Returns the user's texture as an NSData object. The NSData object contains the binary representation of the user's texture as an image in either JPEG, PNG or ARGB32 format.
| - (NSString *) userHash |
Returns the user's hash. Typically, the the hash is the SHA1 digest of the user's X.509 certificate, but could be any unique hash that identifies the user.
| - (NSInteger) userId |
Returns a user's user ID. Only registered users have user IDs. For non-registered users, this ID will be negative. A user ID of 0 signals that the user is the SuperUser.
1.8.2
