Recorder Media Player¶
Recorder Media Player is combination of Recorder and Media Player that is used for User (Agent) for getting recorded media file from Recorder and playing it in way that is described in Media Player.
Recorder Media Player Domain Model¶
Represent the Recorder Media Player domain model with available properties and its behaviors.
Note
Note that domain model is used for write methods POST (Create) and PUT (Update) and as result of read-only method GET/:id (GetById).
Name | Description | Type | Required | Read-only | Default |
---|---|---|---|---|---|
id |
Representing Recorder Media Player identifier. | guid |
yes | yes | |
name |
The name of Recorder Media Player. | string(255) |
yes | no | |
recorderId |
The Recorder reference. | guid |
yes | no | |
mediaPlayerId |
The Media Player reference. | guid |
yes | no | |
isActive |
Denotes whether the Recorder Media Player is active. | bool |
yes | no | active (true ) |
Lookups | |||||
recorders |
The lookup dictionary of Recorder. Used to set the redorderId . |
dictionary(guid, string) |
N/A | N/A | N/A |
mediaPlayers |
The lookup dictionary of Media Players. Used to set the mediaPlayerId . |
dictionary(guid, string) |
N/A | N/A | N/A |
Note
The Recorder Media Player properties names (Name column) is for default usage by JSON
, for C# Wrapper
usage the Recorder Media Player properties are capitalized (eg. Id
, Name
,..)!
Danger
Recorder Media Player List Model¶
Represent the Recorder Media Player list model with available properties.
Note
Name | Description | Type |
---|---|---|
id |
Representing Recorder Media Player identifier. | guid |
name |
The name of Recorder Media Player. | string |
isActive |
Denotes whether the Recorder Media Player is active. | string |
recorderName |
The name of Recorder. | string |
mediaPlayerName |
The name of Media Player. | string |
Note
The Recorder Media Player properties names (Name column) is for default usage by JSON
, for C# Wrapper
usage the Recorder Media Player properties are capitalized (eg. Id
, Name
,..)!
List of Recorder Media Players¶
The list of Recorder Media Players for Current Tenant .
Default REST approach¶
GET /api/v1/:tenantCode/recorder-players
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.
Danger
Remember to add API Key as customer*key and API Secret as customer*secret into your Request HTTP Header. See more in Getting Started.
Return value¶
- If there is no error:
JSON
array of [Recorder Media Player List Model](/v1/recorder-player#recorder-player-list-model). - If there is an error:
JSON
Client Errors object.
C# Wrapper approach¶
1 | RecorderMediaPlayerWrapper(int tenantCode, string apiKey, string apiSecret).GetAll();
|
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.apiKey
Current Tenant API Key provided by Qualtrak.apiSecret
Current Tenant API Secret provided by Qualtrak.
Return value¶
- If there is no error:
ResaultContent<ICollection<RecorderMediaPlayer>>.Result
object collection of the [Recorder Media Player List Model](/v1/recorder-player#recorder-player-list-model). - If there is an error:
ResaultContent<ICollection<RecorderMediaPlayer>>.Error
object. See more in Client Errors.
Example usage¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | int tenantCode = 1000;
string key = "ddZXdAZvWefFqxAEH62u";
string secret = "wx6GiQggg9YRH89XT5aKoY2qZLVquYjxARtgZhuGoFQX5w6Lws";
ITreeApiWrapper<RecorderMediaPlayer, RecorderMediaPlayerList> recorderMediaPlayerWrapper = new RecorderMediaPlayerWrapper(tenantCode, key, secret);
ResponseContent<ICollection<RecorderMediaPlayerList>> response = recorderMediaPlayerWrapper.GetAll();
if (response.Result != null)
{
// Use Result as List of recorder Media Players for displaying.
ICollection<RecorderMediaPlayerList> recorderMediaPlayers = response.Result;
}
else
{
// TODO: The error handling...
Console.WriteLine(response.Error);
}
|
Get Recorder Media Player by Id¶
The Recorder Media Player by requested Id for current Tenant.
Default REST approach¶
GET /api/v1/:tenantCode/recorder-players/:id
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.id
The Recorder Media Player id, a valid and non-emptyguid
.
Danger
Remember to add API Key as customer*key and API Secret as customer*secret into your Request HTTP Header. See more in Getting Started.
Return value¶
- If there is no error:
JSON
as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model) object. - If there is an error:
JSON
as the Client Errors object.
C# Wrapper approach¶
1 | RecorderMediaPlayerWrapper(int tenantCode, string apiKey, string apiSecret).GetById(Guid id);
|
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.apiKey
Current Tenant API Key provided by Qualtrak.apiSecret
Current Tenant API Secret provided by Qualtrak.id
The Recorder Media Player id, a valid and non-emptyguid
.
Return value¶
- If there is no error:
ResaultContent<RecorderMediaPlayer>.Result
object as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model). - If there is an error:
ResaultContent<RecorderMediaPlayer>.Error
object. See more in Client Errors
Example usage¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | int tenantCode = 1000;
string key = "ddZXdAZvWefFqxAEH62u";
string secret = "wx6GiQggg9YRH89XT5aKoY2qZLVquYjxARtgZhuGoFQX5w6Lws";
Guid recorderMediaPlayerId = new Guid("f4fe3ea7-ed2a-41dd-acd2-91c45c8b4891");
ITreeApiWrapper<RecorderMediaPlayer, RecorderMediaPlayerList> recorderMediaPlayerWrapper = new RecorderMediaPlayerWrapper(tenantCode, key, secret);
ResponseContent<RecorderMediaPlayer> response = recorderMediaPlayerWrapper.GetById(recorderMediaPlayerId);
if (response.Result != null)
{
// Use Result as requested Recorder Media Player for displaying.
RecorderMediaPlayer recorderMediaPlayer = response.Result;
}
else
{
// TODO: The error handling...
Console.WriteLine(response.Error);
}
|
Create Recorder Media Player¶
The creation of new Recorder Media Player for current Tenant.
Default REST approach¶
POST /api/v1/:tenantCode/recorder-players
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.recorderMediaPlayer
JSON
representation of Recorder Media Player properties sent via Request HTTP Header.
Danger
Remember to add API Key as customer*key and API Secret as customer*secret into your Request HTTP Header. See more in Getting Started.
Return value¶
- If there is no error:
JSON
representation of newly created Recorder Media Player as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model). - If there is an error:
JSON
Client Errors object.
C# Wrapper approach¶
1 | RecorderMediaPlayerWrapper(int tenantCode, string apiKey, string apiSecret).Create(RecorderMediaPlayer recorderMediaPlayer);
|
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.apiKey
Current Tenant API Key provided by Qualtrak.apiSecret
Current Tenant API Secret provided by Qualtrak.recorderMediaPlayer
The Recorder Media Player model constructed from Recorder Media Player properties.
Return value¶
- If there is no error:
ResaultContent<RecorderMediaPlayer>.Result
object as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model). - If there is an error:
ResaultContent<recorderMediaPlayer>.Error
object. See more in Client Errors.
Example usage¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | int tenantCode = 1000;
string key = "ddZXdAZvWefFqxAEH62u";
string secret = "wx6GiQggg9YRH89XT5aKoY2qZLVquYjxARtgZhuGoFQX5w6Lws";
ITreeApiWrapper<RecorderMediaPlayer, RecorderMediaPlayerList> recorderMediaPlayerWrapper = new RecorderMediaPlayerWrapper(tenantCode, key, secret);
// Get default data and lookup for recorder media players
RecorderMediaPlayer newRecorderMediaPlayer = recorderMediaPlayerWrapper.GetById(new Guid()).Result;
newRecorderMediaPlayer.Name = "Recorder Media Player created from test";
// Set recorder and mediaPlayer from lookups key.
newRecorderMediaPlayer.RecorderId = newRecorderMediaPlayer.Recorders.FirstOrDefault().Key;
newRecorderMediaPlayer.MediaPlayerId = newRecorderMediaPlayer.MediaPlayers.FirstOrDefault().Key;
ResponseContent<RecorderMediaPlayer> response = recorderMediaPlayerWrapper.Create(newRecorderMediaPlayer);
if (response.Result != null)
{
// Use Result as newly created Recorder Media Player for display.
RecorderMediaPlayer recorderMediaPlayer = response.Result;
}
else
{
// TODO: The error handling...
Console.WriteLine(response.Error);
}
|
Update Recorder Media Player¶
Updates already existent Recorder Media Player for current Tenant .
Default REST approach¶
PUT /api/v1/:tenantCode/recorder-players/:id
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.id
The Recorder Media Player id, a valid and non-emptyguid
.recorderMediaPlayer
JSON
representation of recorder Media Player properties sent via Request HTTP Header.
Danger
PUT
verb method read more in Getting Started.Return value¶
- If there is no error:
JSON
representation of uodated Recorder Media Player as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model) object. - If there is an error:
JSON
Client Errors object.
C# Wrapper approach¶
1 | RecorderMediaPlayerWrapper(int tenantCode, string apiKey, string apiSecret).Update(RecorderMediaPlayer recorderMediaPlayer, bool updateViaPost = false);
|
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.apiKey
Current Tenant API Key provided by Qualtrak.apiSecret
Current Tenant API Secret provided by Qualtrak.recorderMediaPlayer
The Recorder Media Player model constructed from Recorder Media Player properties andId
must be provided in it. If notArgumentException
will be thrown!updateViaPost
Set totrue
if in your Web Server you don’t want to enablePUT
method. Default isfalse
or usePUT
method!
Return value¶
- If there is no error:
ResaultContent<RecorderMediaPlayer>.Result
object as the [Recorder Media Player Domain Model](/v1/recorder-player#recorder-player-model). - If there is an error:
ResaultContent<RecorderMediaPlayer>.Error
object. See more in Client Errors.
Example usage¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | int tenantCode = 1000;
string key = "ddZXdAZvWefFqxAEH62u";
string secret = "wx6GiQggg9YRH89XT5aKoY2qZLVquYjxARtgZhuGoFQX5w6Lws";
Guid recorderMediaPlayerId = new Guid("f4fe3ea7-ed2a-41dd-acd2-91c45c8b4891");
ITreeApiWrapper<RecorderMediaPlayer, RecorderMediaPlayerList> recorderMediaPlayerWrapper = new RecorderMediaPlayerWrapper(tenantCode, key, secret);
RecorderMediaPlayer recorderMediaPlayer = recorderMediaPlayerWrapper.GetById(recorderMediaPlayerId).Result;
recorderMediaPlayer.Name = "Recorder Media Player updated from test";
recorderMediaPlayer.RecorderId = recorderMediaPlayer.Recorders.LastOrDefault().Key;
recorderMediaPlayer.MediaPlayerId = recorderMediaPlayer.MediaPlayers.LastOrDefault().Key;
// Update via PUT method (default).
ResponseContent<RecorderMediaPlayer> response = recorderMediaPlayerWrapper.Update(recorderMediaPlayer);
// Update via POST method (use true argument).
// ResponseContent<RecorderMediaPlayer> response = recorderMediaPlayerWrapper.Update(recorderMediaPlayer, true);
if (response.Result != null)
{
// Use Result of updated Recorder Media Player for display.
RecorderMediaPlayer updatedRecorderMediaPlayer = response.Result;
}
else
{
// TODO: The error handling...
Console.WriteLine(response.Error);
}
|
Delete Recorder Media Player¶
Deletes existent Recorder Media Player for current Tenant .
Warning
Note that Recorder Media Player will not be deleted if there are any references of Recorder Media Player in [User](/v1/user).
Default REST approach¶
DELETE /api/v1/:tenantCode/recorder-players/:id
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.id
The Recorder Media Player id, a valid and non-emptyguid
.
Danger
DELETE
verb method read more in Getting Started.Return value¶
- There is no return value except if there is an error, the
JSON
Client Errors object.
C# Wrapper approach¶
1 | RecorderMediaPlayerWrapper(int tenantCode, string apiKey, string apiSecret).Delete(Guid id, bool updateViaPost = false);
|
Parameters¶
tenantCode
Current Tenant code, a validinteger
greater or equal to 1000.apiKey
Current Tenant API Key provided by Qualtrak.apiSecret
Current Tenant API Secret provided by Qualtrak.id
The Recorder Media Player id, a valid and non-emptyguid
.updateViaPost
Set totrue
if in your Web Server you don’t want to enableDELETE
method. Default isfalse
or useDELETE
method!
Return value¶
- If there is no error: no return value or
void
. - If there is an error:
ResaultContent<RecorderMediaPlayer>.Error
object. See more in Client Errors.
Example usage¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | int tenantCode = 1000;
string key = "ddZXdAZvWefFqxAEH62u";
string secret = "wx6GiQggg9YRH89XT5aKoY2qZLVquYjxARtgZhuGoFQX5w6Lws";
Guid recorderMediaPlayerId = new Guid("f4fe3ea7-ed2a-41dd-acd2-91c45c8b4891");
ITreeApiWrapper<RecorderMediaPlayer, RecorderMediaPlayerList> recorderMediaPlayerWrapper = new RecorderMediaPlayerWrapper(tenantCode, key, secret);
// Delete via DELETE method (default).
ResponseContent response = recorderMediaPlayerWrapper.Delete(recorderMediaPlayerId);
// Delete via POST method (use true argument).
// ResponseContent response = recorderMediaPlayerWrapper.Delete(recorderMediaPlayerId, true);
if (response.Error != null)
{
// TODO: The error handling...
Console.WriteLine(response.Error);
}
|