ConstantsMCOP.ControlMechanismEventExtras

java.lang.Object
- org.mcopenplatform.muoapi.ConstantsMCOP.ControlMechanismEventExtras

Enclosing class:: ConstantsMCOP

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum`
`static class`	`ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismOperationTypeEnum`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CALL_TYPE` Key Access to the call type.
`static java.lang.String`	`CAUSE_CODE` Key Access to the cause code of the DENY or REVOKE events received as a response to a media control mechanism related request Response: Integer indicating the code of the cause.
`static java.lang.String`	`CAUSE_STRING` Key Access to the cause string of the DENY or REVOKE events received as a response to a media control mechanism related request.
`static java.lang.String`	`CONTROL_MECHANISM_EVENT` Key Access to the control mechanism event type.
`static java.lang.String`	`DISPLAY_NAME` Key Access to the human-readable display name of the user who is talking at each moment Response: String that identifies the user with a human-readable alias The control mechanism event types in which this tag can be present are: taken `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken`
`static java.lang.String`	`ERROR_CODE` /** Key Access to the error codes associated to the control mechanism events.
`static java.lang.String`	`ERROR_STRING` Key Access to error string associated to the control mechanism events Response: String describing the error.
`static java.lang.String`	`FUNCTIONAL_ALIAS_ID` Key Access to the functional alias of the user causing the event Response: String type value representing the identifier The control mechanism event types in which this tag can be present are: taken `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken` reception_granted `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted` transmission_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response` reception_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response`
`static java.lang.String`	`INACTIVITY_HANG_TIME` Key Access to the maximum inactivity number of seconds.
`static java.lang.String`	`QUEUED_POSITION` Key Access to the position of the performed request, inside the queue.
`static java.lang.String`	`QUEUED_PRIORITY` Key Access to the priority of the floor request in the queue Response: Integer representing the queue priority.
`static java.lang.String`	`REQUEST_ALLOWED` Key Access to the indication representing if the permission to transmit can be requested despite being in #taken state Response: boolean value.
`static java.lang.String`	`SESSION_ID` Key Access to the call session identifier.
`static java.lang.String`	`TAG_CTRL_MECH_MCVIDEO_USER_ID` Key Access to the MCVideo user identification tag.
`static java.lang.String`	`TAG_CTRL_MECH_PRIO` Key Access to the control mechanism optional priority setting tag.
`static java.lang.String`	`TOKEN_DURATION` Key Access to the number of seconds that the client can speak when token has been granted Response: Integer value representing the seconds that the client can speak The control mechanism event types in which this tag can be present are: granted `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.granted`
`static java.lang.String`	`TOKEN_DURATIONG_WARNING_TIME` Key Access to the time warning configured number of seconds.
`static java.lang.String`	`USER_GEO_LATITUDE` Key Access to geographic location latitude data of the user causing the event Response: String type value representing the identifier The control mechanism event types in which this tag can be present are: taken `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken` reception_granted `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted` transmission_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response` reception_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response`
`static java.lang.String`	`USER_GEO_LONGITUDE` Key Access to geographic location longitude data of the user causing the event Response: String type value representing the identifier The control mechanism event types in which this tag can be present are: taken `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken` reception_granted `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted` transmission_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response` reception_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response`
`static java.lang.String`	`USER_ID` Key Access to the MCPTT/MCVIDEO ID of the user causing the event Response: String type value representing the identifier The control mechanism event types in which this tag can be present are: taken `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken` reception_granted `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted` transmission_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response` reception_end_response `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response`

Constructor Summary

Constructors
Constructor and Description

ControlMechanismEventExtras()

Constructors
Constructor and Description
`ControlMechanismEventExtras()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONTROL_MECHANISM_EVENT
```
public static final java.lang.String CONTROL_MECHANISM_EVENT
```
    Key Access to the control mechanism event type. See ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum for all possible values.
    
    Response: Integer type value
    
    This parameter is included in all call type events ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
public static final java.lang.String DISPLAY_NAME
```
    Key Access to the human-readable display name of the user who is talking at each moment
    
    Response: String that identifies the user with a human-readable alias
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    See Also:
    
    Constant Field Values
  - TOKEN_DURATION
```
public static final java.lang.String TOKEN_DURATION
```
    Key Access to the number of seconds that the client can speak when token has been granted
    
    Response: Integer value representing the seconds that the client can speak
    
    The control mechanism event types in which this tag can be present are:
    
    granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.granted
    
    See Also:
    
    Constant Field Values
  - TOKEN_DURATIONG_WARNING_TIME
```
public static final java.lang.String TOKEN_DURATIONG_WARNING_TIME
```
    Key Access to the time warning configured number of seconds.
    
    When the client is talking this represents the number of token duration remaining seconds when the user will be alerted
    
    Response: Integer value representing time warning configured number of seconds.
    
    The control mechanism event types in which this tag can be present are:
    
    granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.granted
    
    See Also:
    
    Constant Field Values
  - INACTIVITY_HANG_TIME
```
public static final java.lang.String INACTIVITY_HANG_TIME
```
    Key Access to the maximum inactivity number of seconds. This indicates the time after which the call will be terminated due to inactivity
    
    Response: Integer value representing the maximum inactivity number of seconds
    
    The control mechanism event types in which this tag can be present are:
    
    idle ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.idle
    
    See Also:
    
    Constant Field Values
  - QUEUED_POSITION
```
public static final java.lang.String QUEUED_POSITION
```
    Key Access to the position of the performed request, inside the queue.
    
    Response: Integer representing the queue position. It can take a value between 0-255. 254 means that the client is not queued.
    
    The control mechanism event types in which this tag can be present are:
    
    queued ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.queued
    
    See Also:
    
    Constant Field Values
  - QUEUED_PRIORITY
```
public static final java.lang.String QUEUED_PRIORITY
```
    Key Access to the priority of the floor request in the queue
    
    Response: Integer representing the queue priority. It can take a value between 0-255.
    
    The control mechanism event types in which this tag can be present are:
    
    queued ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.queued
    
    See Also:
    
    Constant Field Values
  - USER_ID
```
public static final java.lang.String USER_ID
```
    Key Access to the MCPTT/MCVIDEO ID of the user causing the event
    
    Response: String type value representing the identifier
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    reception_granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted
    
    transmission_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response
    
    reception_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response
    
    See Also:
    
    Constant Field Values
  - FUNCTIONAL_ALIAS_ID
```
public static final java.lang.String FUNCTIONAL_ALIAS_ID
```
    Key Access to the functional alias of the user causing the event
    
    Response: String type value representing the identifier
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    reception_granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted
    
    transmission_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response
    
    reception_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response
    
    See Also:
    
    Constant Field Values
  - USER_GEO_LONGITUDE
```
public static final java.lang.String USER_GEO_LONGITUDE
```
    Key Access to geographic location longitude data of the user causing the event
    
    Response: String type value representing the identifier
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    reception_granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted
    
    transmission_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response
    
    reception_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response
    
    See Also:
    
    Constant Field Values
  - USER_GEO_LATITUDE
```
public static final java.lang.String USER_GEO_LATITUDE
```
    Key Access to geographic location latitude data of the user causing the event
    
    Response: String type value representing the identifier
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    reception_granted ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_granted
    
    transmission_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.transmission_end_response
    
    reception_end_response ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.reception_end_response
    
    See Also:
    
    Constant Field Values
  - REQUEST_ALLOWED
```
public static final java.lang.String REQUEST_ALLOWED
```
    Key Access to the indication representing if the permission to transmit can be requested despite being in #taken state
    
    Response: boolean value. True means that requests could be performed.
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    See Also:
    
    Constant Field Values
  - SESSION_ID
```
public static final java.lang.String SESSION_ID
```
    Key Access to the call session identifier. This identifier is unique for each call.
    
    Response: String type value
    
    This parameter is included in all control mechanism type events ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum
    
    See Also:
    
    Constant Field Values
  - CALL_TYPE
```
public static final java.lang.String CALL_TYPE
```
    Key Access to the call type. See ConstantsMCOP.CallEventExtras.CallTypeEnum for all possible values.
    
    Response: Integer type value
    
    This parameter is included in all control mechanism type events ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum
    
    See Also:
    
    Constant Field Values
  - CAUSE_CODE
```
public static final java.lang.String CAUSE_CODE
```
    Key Access to the cause code of the DENY or REVOKE events received as a response to a media control mechanism related request
    
    Response: Integer indicating the code of the cause.
    
    Values:
    
    Event ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.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.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.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.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.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.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.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.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.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.
    
    The control mechanism event types in which this tag can be present are:
    
    taken ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.taken
    
    See Also:
    
    Constant Field Values
  - CAUSE_STRING
```
public static final java.lang.String CAUSE_STRING
```
    Key Access to the cause string of the DENY or REVOKE events received as a response to a media control mechanism related request.
    
    Response: String describing the cause
    
    The control mechanism event types in which this tag can be present are:
    
    denied ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.denied
    
    revoked ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.revoked
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final java.lang.String ERROR_CODE
```
    /**
    Key Access to the error codes associated to the control mechanism events.
    
    Response: Integer indicating the error code.
    
    Values:
    
    Code Explanatory text Description
    
    101 The session cannot be accepted because it has not received any session for that sessionID
    
    102 Floor control invalid operation
    
    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.
    
    The control mechanism event types in which this tag can be present are:
    
    error ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.error
    
    See Also:
    
    Constant Field Values
  - ERROR_STRING
```
public static final java.lang.String ERROR_STRING
```
    Key Access to error string associated to the control mechanism events
    
    Response: String describing the error.
    
    The control mechanism event types in which this tag can be present are:
    
    error ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum.error
    
    See Also:
    
    Constant Field Values
  - TAG_CTRL_MECH_PRIO
```
public static final java.lang.String TAG_CTRL_MECH_PRIO
```
    Key Access to the control mechanism optional priority setting tag.
    
    Used to set the priority level of a request. It can take a value between 0-255.
    
    It can be used in control mechanism requests to set the priority level of a request IMCOPsdk.controlMechanismOperation(String, int, Map)
    
    Contains a integer between 0-255.
    
    See Also:
    
    Constant Field Values
  - TAG_CTRL_MECH_MCVIDEO_USER_ID
```
public static final java.lang.String TAG_CTRL_MECH_MCVIDEO_USER_ID
```
    Key Access to the MCVideo user identification tag.
    
    Used in transmission control mechanism in MCVideo session to select the user referred in the request.
    
    It can be used in transmission control mechanism to set user whose video media wants to be received IMCOPsdk.controlMechanismOperation(String, int, Map)
    
    Contains a string type value representing the identifier.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ControlMechanismEventExtras
```
public ControlMechanismEventExtras()
```

Class ConstantsMCOP.ControlMechanismEventExtras

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTROL_MECHANISM_EVENT

Key Access to the control mechanism event type. See ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum for all possible values.

DISPLAY_NAME

Key Access to the human-readable display name of the user who is talking at each moment

TOKEN_DURATION

Key Access to the number of seconds that the client can speak when token has been granted

TOKEN_DURATIONG_WARNING_TIME

Key Access to the time warning configured number of seconds.

INACTIVITY_HANG_TIME

Key Access to the maximum inactivity number of seconds. This indicates the time after which the call will be terminated due to inactivity

QUEUED_POSITION

Key Access to the position of the performed request, inside the queue.

QUEUED_PRIORITY

Key Access to the priority of the floor request in the queue

USER_ID

Key Access to the MCPTT/MCVIDEO ID of the user causing the event

FUNCTIONAL_ALIAS_ID

Key Access to the functional alias of the user causing the event

USER_GEO_LONGITUDE

Key Access to geographic location longitude data of the user causing the event

USER_GEO_LATITUDE

Key Access to geographic location latitude data of the user causing the event

REQUEST_ALLOWED

Key Access to the indication representing if the permission to transmit can be requested despite being in #taken state

SESSION_ID

Key Access to the call session identifier. This identifier is unique for each call.

CALL_TYPE

Key Access to the call type. See ConstantsMCOP.CallEventExtras.CallTypeEnum for all possible values.

CAUSE_CODE

Key Access to the cause code of the DENY or REVOKE events received as a response to a media control mechanism related request

CAUSE_STRING

Key Access to the cause string of the DENY or REVOKE events received as a response to a media control mechanism related request.

ERROR_CODE

Key Access to the error codes associated to the control mechanism events.

ERROR_STRING

Key Access to error string associated to the control mechanism events

TAG_CTRL_MECH_PRIO

Key Access to the control mechanism optional priority setting tag.

TAG_CTRL_MECH_MCVIDEO_USER_ID

Key Access to the MCVideo user identification tag.

Constructor Detail

ControlMechanismEventExtras

Key Access to the control mechanism event type. See `ConstantsMCOP.ControlMechanismEventExtras.ControlMechanismEventTypeEnum` for all possible values.

Key Access to the call type. See `ConstantsMCOP.CallEventExtras.CallTypeEnum` for all possible values.