PlugNmeet
in package
Table of Contents
Properties
- $algo : string
- $apiKey : string
- $apiSecret : string
- $defaultPath : string
- $serverUrl : string
Methods
- __construct() : mixed
- createRoom() : CreateRoomResponse
- Create new room
- decodeJWTData() : stdClass
- deleteAnalytics() : DeleteAnalyticsResponse
- To delete analytics
- deleteRecordings() : DeleteRecordingResponse
- To delete recording
- endRoom() : EndRoomResponse
- End active room
- fetchAnalytics() : FetchAnalyticsResponse
- To fetch analytics
- fetchPastRoomsInfo() : FetchPastRoomsResponse
- Get all past rooms
- fetchRecordings() : FetchRecordingsResponse
- To fetch recordings
- generateUuid4() : string
- Generate UUID v4 random string
- getActiveRoomInfo() : GetActiveRoomInfoResponse
- Get active room information
- getActiveRoomsInfo() : GetActiveRoomsInfoResponse
- Get all active rooms
- getAnalyticsDownloadToken() : AnalyticsDownloadTokenResponse
- Generate token to download analytics
- getClientFiles() : ClientFilesResponses
- getJoinToken() : GenerateJoinTokenResponse
- Generate join token
- getJWTencodedData() : string
- getRecordingDownloadToken() : RecordingDownloadTokenResponse
- Generate token to download recording
- getRecordingInfo() : RecordingInfoResponse
- To get recording info
- getUUID() : string
- Generate UUID random string
- isRoomActive() : IsRoomActiveResponse
- To check if room is active or not
- sendRequest() : stdClass
Properties
$algo
protected
string
$algo
= "sha256"
$apiKey
protected
string
$apiKey
$apiSecret
protected
string
$apiSecret
$defaultPath
protected
string
$defaultPath
= "/auth"
$serverUrl
protected
string
$serverUrl
Methods
__construct()
public
__construct(mixed $serverUrl, mixed $apiKey, mixed $apiSecret) : mixed
Parameters
- $serverUrl : mixed
-
plugNmeet server URL
- $apiKey : mixed
-
plugNmeet API_Key
- $apiSecret : mixed
-
plugNmeet API_Secret
createRoom()
Create new room
public
createRoom(CreateRoomParameters $createRoomParameters) : CreateRoomResponse
Parameters
- $createRoomParameters : CreateRoomParameters
Return values
CreateRoomResponsedecodeJWTData()
public
decodeJWTData(string $raw[, string $algo = "HS256" ]) : stdClass
Parameters
- $raw : string
- $algo : string = "HS256"
Return values
stdClassdeleteAnalytics()
To delete analytics
public
deleteAnalytics(DeleteAnalyticsParameters $deleteAnalyticsParameters) : DeleteAnalyticsResponse
Parameters
- $deleteAnalyticsParameters : DeleteAnalyticsParameters
Return values
DeleteAnalyticsResponsedeleteRecordings()
To delete recording
public
deleteRecordings(DeleteRecordingParameters $deleteRecordingParameters) : DeleteRecordingResponse
Parameters
- $deleteRecordingParameters : DeleteRecordingParameters
Return values
DeleteRecordingResponseendRoom()
End active room
public
endRoom(EndRoomParameters $endRoomParameters) : EndRoomResponse
Parameters
- $endRoomParameters : EndRoomParameters
Return values
EndRoomResponsefetchAnalytics()
To fetch analytics
public
fetchAnalytics(FetchAnalyticsParameters $fetchAnalyticsParameters) : FetchAnalyticsResponse
Parameters
- $fetchAnalyticsParameters : FetchAnalyticsParameters
Return values
FetchAnalyticsResponsefetchPastRoomsInfo()
Get all past rooms
public
fetchPastRoomsInfo(FetchPastRoomsParameters $fetchPastRoomsParameters) : FetchPastRoomsResponse
Parameters
- $fetchPastRoomsParameters : FetchPastRoomsParameters
Return values
FetchPastRoomsResponsefetchRecordings()
To fetch recordings
public
fetchRecordings(FetchRecordingsParameters $fetchRecordingsParameters) : FetchRecordingsResponse
Parameters
- $fetchRecordingsParameters : FetchRecordingsParameters
Return values
FetchRecordingsResponsegenerateUuid4()
Generate UUID v4 random string
public
static generateUuid4() : string
Return values
stringgetActiveRoomInfo()
Get active room information
public
getActiveRoomInfo(GetActiveRoomInfoParameters $getActiveRoomInfoParameters) : GetActiveRoomInfoResponse
Parameters
- $getActiveRoomInfoParameters : GetActiveRoomInfoParameters
Return values
GetActiveRoomInfoResponsegetActiveRoomsInfo()
Get all active rooms
public
getActiveRoomsInfo() : GetActiveRoomsInfoResponse
Return values
GetActiveRoomsInfoResponsegetAnalyticsDownloadToken()
Generate token to download analytics
public
getAnalyticsDownloadToken(AnalyticsDownloadTokenParameters $analyticsDownloadTokenParameters) : AnalyticsDownloadTokenResponse
Parameters
- $analyticsDownloadTokenParameters : AnalyticsDownloadTokenParameters
Return values
AnalyticsDownloadTokenResponsegetClientFiles()
public
getClientFiles() : ClientFilesResponses
Return values
ClientFilesResponsesgetJoinToken()
Generate join token
public
getJoinToken(GenerateJoinTokenParameters $generateJoinTokenParameters) : GenerateJoinTokenResponse
Parameters
- $generateJoinTokenParameters : GenerateJoinTokenParameters
Return values
GenerateJoinTokenResponsegetJWTencodedData()
public
getJWTencodedData(array<string|int, mixed> $payload, int $validity[, string $algo = "HS256" ][, array<string|int, mixed> $head = [] ]) : string
Parameters
- $payload : array<string|int, mixed>
- $validity : int
-
in seconds
- $algo : string = "HS256"
- $head : array<string|int, mixed> = []
Return values
stringgetRecordingDownloadToken()
Generate token to download recording
public
getRecordingDownloadToken(RecordingDownloadTokenParameters $recordingDownloadTokenParameters) : RecordingDownloadTokenResponse
Parameters
- $recordingDownloadTokenParameters : RecordingDownloadTokenParameters
Return values
RecordingDownloadTokenResponsegetRecordingInfo()
To get recording info
public
getRecordingInfo(RecordingInfoParameters $recordingInfoParameters) : RecordingInfoResponse
Parameters
- $recordingInfoParameters : RecordingInfoParameters
Return values
RecordingInfoResponsegetUUID()
Generate UUID random string
public
getUUID() : string
Return values
stringisRoomActive()
To check if room is active or not
public
isRoomActive(IsRoomActiveParameters $isRoomActiveParameters) : IsRoomActiveResponse
Parameters
- $isRoomActiveParameters : IsRoomActiveParameters
Return values
IsRoomActiveResponsesendRequest()
protected
sendRequest(mixed $path, array<string|int, mixed> $body) : stdClass
Parameters
- $path : mixed
- $body : array<string|int, mixed>