org.mcopenplatform.muoapi

Class ConstantsMCOP.FloorControlEventExtras

java.lang.Object

org.mcopenplatform.muoapi.ConstantsMCOP.FloorControlEventExtras

Enclosing class:

ConstantsMCOP

public static class ConstantsMCOP.FloorControlEventExtras
extends java.lang.Object

Key Access to the values of the floor control events in any MCPTT session.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum Types of event referred to the floor control of an MCPTT session and received on key FLOOR_CONTROL_EVENT events.
static class	ConstantsMCOP.FloorControlEventExtras.FloorControlOperationTypeEnum Operation types performed in method IMCOPsdk.floorControlOperation(String, int, String) for MCPTT session control management.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_REQUEST Key Access to ALLOW REQUEST that indicates whether a call can be made to IMCOPsdk.floorControlOperation(String, int, String) to request the token despite being in a ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken state This data will be obtained every time a ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken event is received.
static java.lang.String	CAUSE_CODE Key Access to the numbering of a specific MCPTT session control denial or revocation event.
static java.lang.String	CAUSE_STRING Key Access to the string of the cause codes.
static java.lang.String	DISPLAY_NAME Key Access to DISPLAY NAME of the client linked to one of the events in ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum It is usually used with the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken to know who is talking at each moment.
static java.lang.String	DURATION_TOKEN Key Access to DURATION TOKEN of Number of seconds that a client can speak ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum It is usually used with the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.granted to know who is talking at each moment.
static java.lang.String	ERROR_CODE Key Access to Error Codes All error codes are integers: Code Explanatory text Description 103 maximum simultaneous MCPTT group calls reached The number of maximum simultaneous MCPTT group calls supported for the MCPTT user has been exceeded.
static java.lang.String	ERROR_STRING Key Access to the Error codes string.
static java.lang.String	FLOOR_CONTROL_EVENT Key Access to the list of floor control events.
static java.lang.String	SESSION_ID Key Access to MCPTT calls Session ID.
static java.lang.String	USER_ID Key Access to User ID that univocally distinguishes the MCPTT user causing the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum Usually used with events: ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken to know who is talking at each moment.

Constructor Summary

Constructors

Constructor and Description
FloorControlEventExtras()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLOOR_CONTROL_EVENT

public static final java.lang.String FLOOR_CONTROL_EVENT

Key Access to the list of floor control events.

This event is received every time an action is generated on any floor control of any MCPTT session.

Response: String

Values:

granted (Session control granted) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.granted

idle (Nobody has control of the session) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.idle

taken (Other session participant has control) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken

request_sent (Session control request sent) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.request_sent

release_sent (Session control release sent) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.idle

denied (Session control denied) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.denied

revoked (Session control revoked) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.revoked

queued (Session control request queued) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.queued

queued_timeout (Queued request timed out) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.queued_timeout

transmission_granted (Transmission granted) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_granted

reception_granted (Reception granted) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_granted

transmission_rejection (Transmission rejected) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_rejection

reception_rejection (Reception rejected) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_rejection

transmission_revoke (Transmission revoked) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_revoke

reception_revoke (Reception revoked) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_revoke

transmission_notification (Transmission notification) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_notification

transmission_end_notification (Transmission notification end) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_end_notification

transmission_end_response (Transmission end response) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_end_response

reception_end_response (Reception end response) ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_end_response

See Also:

Constant Field Values

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

Key Access to DISPLAY NAME of the client linked to one of the events in ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum

It is usually used with the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken to know who is talking at each moment.

Response: String that identifies the user with a human-readable alias, more pleasant than a MCPTT identifier.

See Also:

Constant Field Values

DURATION_TOKEN

public static final java.lang.String DURATION_TOKEN

Key Access to DURATION TOKEN of Number of seconds that a client can speak ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum

It is usually used with the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.granted to know who is talking at each moment.

Response: Number of seconds that a client can speak.

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

Key Access to User ID that univocally distinguishes the MCPTT user causing the event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum

Usually used with events:

ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken to know who is talking at each moment.

ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_granted

ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_end_response

ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_end_response

Response: String with URI format that identifies the MCPTT user.

See Also:

Constant Field Values

ALLOW_REQUEST

public static final java.lang.String ALLOW_REQUEST

Key Access to ALLOW REQUEST that indicates whether a call can be made to IMCOPsdk.floorControlOperation(String, int, String) to request the token despite being in a ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken state

This data will be obtained every time a ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.taken event is received.

Response: boolean

See Also:

Constant Field Values

SESSION_ID

public static final java.lang.String SESSION_ID

Key Access to MCPTT calls Session ID. This identifier is unique for each call. It occurs in all types of ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum events.

See Also:

Constant Field Values

CAUSE_CODE

public static final java.lang.String CAUSE_CODE

Key Access to the numbering of a specific MCPTT session control denial or revocation event.

Response: Integer indicating the code of the cause.

Values:

Event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.denied:

101 Cause #1 - Another MCPTT client has permission The value set to '1' indicates that another MCPTT user has permission to send a media.

102 Cause #2 - Internal floor control server error The value set to '2' indicates that the floor control server cannot grant the floor request due to an internal error.

103 Cause #3 - Only one participant The value set to '3' indicates that the floor control server cannot grant the floor request, because the requesting party is the only participant in the MCPTT session.

104 Cause #4 - Retry-after timer has not expired The value set to '4' indicates that the floor control server cannot grant the floor request, because timer T9 (Retry-after) has not expired after permission to send media has been revoked.

105 Cause #5 - Receive only The value set to '5' indicates that the floor control server cannot grant the floor request, because the requesting party only has receive privilege.

106 Cause #6 - No resources available The value set to '6' indicates that the floor control server cannot grant the floor request due to congestion.

107 Cause #7 – Queue full The value set to 7 indicates that the floor control server cannot queue the floor request, because the queue is full.

108 Cause #255 - Other reason The value set to '255' indicates that the floor control server does not grant the floor request due to the floor control server local policy.

Event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.revoked:

201 Cause #1 – Only one MCPTT client The value set to '1' indicates that the MCPTT client is the only MCPTT client in the MCPTT session or the only participant connected to a floor control server. No additional information included.

202 Cause #2 – Media burst too long The value set to '2' indicates that the MCPTT User has talked too long (e.g., the stop-talking timer has expired). No additional information included.

203 Cause #3 - No permission to send a Media Burst The value set to '3' indicates that the MCPTT client does not have permission to send media. No additional information is included.

204 Cause #4 - Media Burst pre-empted The value set to '4' indicates that the MCPTT client 's permission to send a media is being pre-empted. No additional information is included.

205 Cause #6 - No resources available The value set to '6' indicates that the floor control server can no longer grant MCPTT client to send media due to congestion. No additional information is included.

206 Cause #255 – Other reason The value set to '255' indicates that the floor control server can no longer grant MCPTT client to send media due to the floor control server local policy. No additional information is included.

Event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_rejection:

301 Cause #1 - Transmission limit reached The value set to '1' indicates that the number of transmitters have reached maximum.

302 Cause #2 - Internal transmission control server error The value set to '2' indicates that the transmission control server cannot grant the transmission request due to an internal error.

303 Cause #3 - Only one participant The value set to '3' indicates that the transmission control server cannot grant the transmission request, because the requesting party is the only participant in the MCVideo session.

304 Cause #4 - Retry-after timer has not expired The value set to '4' indicates that the transmission control server cannot grant the transmission request, because timer T9 (Retry-after) has not expired after permission to send media has been revoked.

305 Cause #5 - Receive only The value set to '5' indicates that the transmission control server cannot grant the transmission request, because the requesting party only has receive privilege.

306 Cause #6 - No resources available The value set to '6' indicates that the transmission control server cannot grant the transmission request due to congestion.

307 Cause #255 - Other reason The value set to '255' indicates that the transmission control server does not grant the transmission request due to the transmission control server local policy.

Event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.transmission_revoke:

401 Cause #1 – Only one MCVideo client The value set to '1' indicates that the MCVideo client is the only MCVideo client in the MCVideo session or the only participant connected to a transmission control server. No additional information included.

402 Cause #2 – Media burst too long The value set to '2' indicates that the MCVideo User has transmitted too long (e.g., the stop-transmission timer has expired). No additional information included.

403 Cause #3 - No permission to send a Media Burst The value set to '3' indicates that the MCVideo client does not have permission to send media. No additional information is included.

404 Cause #4 - Media Burst pre-empted The value set to '4' indicates that the MCVideo client's permission to send a media is being pre-empted. No additional information is included.

405 Cause #6 - No resources available The value set to '6' indicates that the transmission control server can no longer grant MCVideo client to send media due to congestion. No additional information is included.

406 Cause #255 – Other reason The value set to '255' indicates that the transmission control server can no longer grant MCVideo client to send media due to the transmission control server local policy. No additional information is included.

Event ConstantsMCOP.FloorControlEventExtras.FloorControlEventTypeEnum.reception_rejection:

501 Cause #2 - Internal transmission control server error The value set to '2' indicates that the transmission control server cannot grant the receive media request due to an internal error.

502 Cause #4 - Retry-after timer has not expired The value set to '4' indicates that the transmission control server cannot grant the receive media request, because timer T9 (Retry-after) has not expired after permission to send media has been revoked.

503 Cause #5 - Send only The value set to '5' indicates that the transmission control server cannot grant the receive media request, because the requesting party only has send privilege.

504 Cause #6 - No resources available The value set to '6' indicates that the transmission control server cannot grant the receive media request due to congestion.

505 Cause #255 - Other reason The value set to '255' indicates that the transmission control server does not grant the receive media request due to the transmission control server local policy.

See Also:

Constant Field Values

CAUSE_STRING

public static final java.lang.String CAUSE_STRING

Key Access to the string of the cause codes.

See Also:

Constant Field Values

ERROR_CODE

public static final java.lang.String ERROR_CODE

Key Access to Error Codes

All error codes are integers:

Code Explanatory text Description

103 maximum simultaneous MCPTT group calls reached The number of maximum simultaneous MCPTT group calls supported for the MCPTT user has been exceeded.

104 isfocus not assigned A controlling MCPTT function has not been assigned to the MCPTT session.

/**

Key Access to the floor control error codes.

Response: Integer indicating the error code.

Values:

0 means no error.

Code Description

101 The session cannot be accepted because it has not received any session for that sessionID

102 Floor control invalid operation

See Also:

Constant Field Values

ERROR_STRING

public static final java.lang.String ERROR_STRING

Key Access to the Error codes string.

See Also:

Constant Field Values

Constructor Detail

FloorControlEventExtras

public FloorControlEventExtras()