Package io.antmedia.websocket

Class WebSocketConstants

java.lang.Object
io.antmedia.websocket.WebSocketConstants
public class WebSocketConstants extends Object

  • Field Details

    • ATTR_STREAM_NAME

      public static final String ATTR_STREAM_NAME
      See Also:

    • ATTR_ROOM_NAME

      public static final String ATTR_ROOM_NAME
      See Also:

    • NOTIFICATION_COMMAND

      public static final String NOTIFICATION_COMMAND
      See Also:

    • PING_COMMAND

      public static final String PING_COMMAND
      See Also:

    • PONG_COMMAND

      public static final String PONG_COMMAND
      See Also:

    • COMMAND

      public static final String COMMAND
      See Also:

    • ATTR_SIGNALLING_CONNECTION

      public static final String ATTR_SIGNALLING_CONNECTION
      See Also:

    • STREAM_ID

      public static final String STREAM_ID
      See Also:

    • STREAM_NAME

      public static final String STREAM_NAME
      See Also:

    • DEFINITION

      public static final String DEFINITION
      See Also:

    • CANDIDATE_LABEL

      public static final String CANDIDATE_LABEL
      See Also:

    • SDP

      public static final String SDP
      See Also:

    • TYPE

      public static final String TYPE
      See Also:

    • PLAY_FINISHED

      public static final String PLAY_FINISHED
      See Also:

    • PLAY_STARTED

      public static final String PLAY_STARTED
      See Also:

    • CANDIDATE_ID

      public static final String CANDIDATE_ID
      See Also:

    • TOGGLE_AUDIO_COMMAND

      public static final String TOGGLE_AUDIO_COMMAND
      See Also:

    • TOGGLE_VIDEO_COMMAND

      public static final String TOGGLE_VIDEO_COMMAND
      See Also:

    • CANDIDATE_SDP

      public static final String CANDIDATE_SDP
      See Also:

    • TAKE_CONFIGURATION_COMMAND

      public static final String TAKE_CONFIGURATION_COMMAND
      See Also:

    • TAKE_CANDIDATE_COMMAND

      public static final String TAKE_CANDIDATE_COMMAND
      See Also:

    • ERROR_COMMAND

      public static final String ERROR_COMMAND
      See Also:

    • PLAY_COMMAND

      public static final String PLAY_COMMAND
      See Also:

    • STOP_COMMAND

      public static final String STOP_COMMAND
      See Also:

    • START_COMMAND

      public static final String START_COMMAND
      See Also:

    • PUBLISH_COMMAND

      public static final String PUBLISH_COMMAND
      See Also:

    • PUBLISH_STARTED

      public static final String PUBLISH_STARTED
      See Also:

    • PUBLISH_FINISHED

      public static final String PUBLISH_FINISHED
      See Also:

    • ERROR_CODE

      public static final String ERROR_CODE
      See Also:

    • REGISTER_ORIGIN_SERVER

      public static final String REGISTER_ORIGIN_SERVER
      See Also:

    • REGISTER_EDGE_SERVER

      public static final String REGISTER_EDGE_SERVER
      See Also:

    • REGISTER_BROADCAST

      public static final String REGISTER_BROADCAST
      See Also:

    • NO_STREAM_EXIST

      public static final String NO_STREAM_EXIST
      See Also:

    • JOIN_ROOM_COMMAND

      public static final String JOIN_ROOM_COMMAND
      See Also:

    • STREAMING_STARTED

      public static final String STREAMING_STARTED
      This is the command that is sent from the server when a stream is started so that player can send a play command or take any action
      See Also:

    • GET_ICE_SERVER_CONFIG

      public static final String GET_ICE_SERVER_CONFIG
      Command to get ICE server configuration to frontend from server
      See Also:

    • ICE_SERVER_CONFIG_NOTIFICATION

      public static final String ICE_SERVER_CONFIG_NOTIFICATION
      See Also:

    • STUN_SERVER_URI

      public static final String STUN_SERVER_URI
      See Also:

    • TURN_SERVER_USERNAME

      public static final String TURN_SERVER_USERNAME
      See Also:

    • TURN_SERVER_CREDENTIAL

      public static final String TURN_SERVER_CREDENTIAL
      See Also:

    • ROOM

      @Deprecated(forRemoval=true, since="2.11.3") public static final String ROOM
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use MAIN_TRACK instead
      See Also:

    • JOIN_COMMAND

      public static final String JOIN_COMMAND
      See Also:

    • SERVER_WILL_STOP

      public static final String SERVER_WILL_STOP
      See Also:

    • TRACK_ID

      public static final String TRACK_ID
      See Also:

    • ENABLED

      public static final String ENABLED
      See Also:

    • LEAVE_THE_ROOM

      public static final String LEAVE_THE_ROOM
      this is for leaving from room in 1-N and N-N connection
      See Also:

    • JOINED_THE_ROOM

      public static final String JOINED_THE_ROOM
      See Also:

    • LEAVED_THE_ROOM

      public static final String LEAVED_THE_ROOM
      See Also:

    • ROOM_NOT_ACTIVE

      public static final String ROOM_NOT_ACTIVE
      This is error definition and it's sent when one requests to get room information and there is no active stream or no room
      See Also:

    • TOKEN

      public static final String TOKEN
      this token is used to access resources or start broadcast when token security is enabled
      See Also:

    • SUBSCRIBER_ID

      public static final String SUBSCRIBER_ID
      this subscriber id is used to access resources or start broadcast when time based subscriber security is enabled
      See Also:

    • SUBSCRIBER_NAME

      public static final String SUBSCRIBER_NAME
      this subscriber name is the human readable name for a subscriber
      See Also:

    • SUBSCRIBER_CODE

      public static final String SUBSCRIBER_CODE
      this subscriber code is used to access resources or start broadcast when time based subscriber security is enabled
      See Also:

    • NO_PEER_ASSOCIATED

      public static final String NO_PEER_ASSOCIATED
      This is peer to peer connection error definition. It is sent back to the user when there is no peer associated with the stream
      See Also:

    • JOINED_THE_STREAM

      public static final String JOINED_THE_STREAM
      This is peer to peer connection notification. It is sent back to the user when it is joined to a stream
      See Also:

    • LEAVE_COMMAND

      public static final String LEAVE_COMMAND
      This is p2p connection command Peer send it to leave the room
      See Also:

    • LEAVED_STREAM

      public static final String LEAVED_STREAM
      This is peer to peer connection notification ıt is sent back to the suser when it is leaved from the stream
      See Also:

    • NOT_ALLOWED_UNREGISTERED_STREAM

      public static final String NOT_ALLOWED_UNREGISTERED_STREAM
      This is sent back to the user if publisher wants to send a stream with an unregistered id and server is configured not to allow this kind of streams
      See Also:

    • MAX_SUBTRACK_COUNT_REACHED

      public static final String MAX_SUBTRACK_COUNT_REACHED
      This is sent back to the user if mainTrack
      See Also:

    • NO_ROOM_SPECIFIED

      public static final String NO_ROOM_SPECIFIED
      This is sent back to the user when there is no room specified in joining the video conference
      See Also:

    • NOT_INITIALIZED_YET

      public static final String NOT_INITIALIZED_YET
      This is sent back to the user when context is not initialized yet
      See Also:

    • ROOM_TIME_INVALID

      public static final String ROOM_TIME_INVALID
      This is sent back to the user when there is no room specified in joining the video conference
      See Also:

    • STREAM_TIME_INVALID

      public static final String STREAM_TIME_INVALID
      This is sent back to the user when stream plannedStartDate and plannedEndDate values are in interval or not.
      See Also:

    • UNAUTHORIZED

      public static final String UNAUTHORIZED
      This is sent back to the user if token is not valid
      See Also:

    • BLOCKED

      public static final String BLOCKED
      This is sent back to the user when subscriber is blocked to play or publish
      See Also:

    • ALREADY_PLAYING

      public static final String ALREADY_PLAYING
      This is sent back to the user when a new play message received while it is playing or it is just to play
      See Also:

    • ALREADY_PUBLISHING

      public static final String ALREADY_PUBLISHING
      This is sent back to the user when a new publish message received while there it's publishing or it's just to publish
      See Also:

    • NO_CODEC_ENABLED_IN_THE_SERVER

      public static final String NO_CODEC_ENABLED_IN_THE_SERVER
      This is sent back to the user when there is no codec enabled in the server and someone try to make a publish
      See Also:

    • GET_STREAM_INFO_COMMAND

      public static final String GET_STREAM_INFO_COMMAND
      Command that let server returns information about a specific stream. This info includes height, bitrates, etc.
      See Also:

    • FORCE_STREAM_QUALITY

      public static final String FORCE_STREAM_QUALITY
      Command that stream set resolution request.
      See Also:

    • RESOLUTION_CHANGE_INFO_COMMAND

      public static final String RESOLUTION_CHANGE_INFO_COMMAND
      Command that client stream change resolution notication.
      See Also:

    • GET_ROOM_INFO_COMMAND

      public static final String GET_ROOM_INFO_COMMAND
      Command that let server returns information about a specific room. This info includes stream ID's list in room.
      See Also:

    • STREAM_INFORMATION_NOTIFICATION

      public static final String STREAM_INFORMATION_NOTIFICATION
      Notification field used when returning stream information
      See Also:

    • ROOM_INFORMATION_NOTIFICATION

      public static final String ROOM_INFORMATION_NOTIFICATION
      Notification field used when returning room information
      See Also:

    • STREAM_INFO

      public static final String STREAM_INFO
      Field in messaging to specify the stream info
      See Also:

    • STREAM_WIDTH

      public static final String STREAM_WIDTH
      Field to specify the stream width
      See Also:

    • STREAM_HEIGHT

      public static final String STREAM_HEIGHT
      Field to specify the stream height
      See Also:

    • VIDEO_BITRATE

      public static final String VIDEO_BITRATE
      Field to specify the stream video bitrate
      See Also:

    • AUDIO_BITRATE

      public static final String AUDIO_BITRATE
      Field to specify the stream audio bitrate
      See Also:

    • TARGET_BITRATE

      public static final String TARGET_BITRATE
      Field to specify the measured bitrate for a WebRTCClient
      See Also:

    • VIDEO_CODEC

      public static final String VIDEO_CODEC
      Field to specify the stream video codec
      See Also:

    • VIDEO

      public static final String VIDEO
      video field that defines if there is video
      See Also:

    • AUDIO

      public static final String AUDIO
      audio field that defines if there is audio
      See Also:

    • STREAMS_IN_ROOM

      public static final String STREAMS_IN_ROOM
      Stream Id list in the room
      See Also:

    • STREAM_LIST_IN_ROOM

      public static final String STREAM_LIST_IN_ROOM
      Stream Name list in the room
      See Also:

    • NO_STREAM_ID_SPECIFIED

      public static final String NO_STREAM_ID_SPECIFIED
      Error definition it is send when stream id is not specified in the message
      See Also:

    • NOT_SET_LOCAL_DESCRIPTION

      public static final String NOT_SET_LOCAL_DESCRIPTION
      Error definition it is send when local description is not set successfully
      See Also:

    • STREAM_ID_IN_USE

      public static final String STREAM_ID_IN_USE
      Error definition it is send when publisher tries to publish with in use stream id
      See Also:

    • HIGH_RESOURCE_USAGE

      public static final String HIGH_RESOURCE_USAGE
      Error definition it is send when cpu usage exceeds the limit
      See Also:

    • VIEWER_LIMIT_REACHED

      public static final String VIEWER_LIMIT_REACHED
      Error definition it is send when viewer limit reached
      See Also:

    • INVALID_STREAM_NAME

      public static final String INVALID_STREAM_NAME
      Error definition it is send when stream name contains special characters
      See Also:

    • ENCODER_NOT_OPENED

      public static final String ENCODER_NOT_OPENED
      Error definition, it's send when video encoder is not opened
      See Also:

    • ENCODER_BLOCKED

      public static final String ENCODER_BLOCKED
      Error definition, it's send when video encoder is blocked
      See Also:

    • PUBLISH_TIMEOUT_ERROR

      public static final String PUBLISH_TIMEOUT_ERROR
      Error definition, it's send when publishing has not started and timeout
      See Also:

    • NOT_SET_REMOTE_DESCRIPTION

      public static final String NOT_SET_REMOTE_DESCRIPTION
      Error definition, it's send when remote description is not set, it's generally due to encoder incompatibilities
      See Also:

    • ATTR_P2P_MULTIPEER

      public static final String ATTR_P2P_MULTIPEER
      P2P Mode used in session user parameters
      See Also:

    • ATTR_P2P_MODE

      public static final String ATTR_P2P_MODE
      P2P Mode used in session user parameters
      See Also:

    • P2P_MODE_PLAY

      public static final String P2P_MODE_PLAY
      P2P Mode play
      See Also:

    • P2P_MODE_BOTH

      public static final String P2P_MODE_BOTH
      P2P Mode both
      See Also:

    • CONNECT_WITH_NEW_ID_COMMAND

      public static final String CONNECT_WITH_NEW_ID_COMMAND
      This command used for P2P connections with multipeers to connect new peers to generated new connections with desired id
      See Also:

    • START_NEW_P2P_CONNECTION_COMMAND

      public static final String START_NEW_P2P_CONNECTION_COMMAND
      This command used for P2P connections with multipeers to start new connection with desired id
      See Also:

    • PEER_MESSAGE_COMMAND

      public static final String PEER_MESSAGE_COMMAND
      This command used for message and data transfer between peers
      See Also:

    • ENABLE_TRACK

      public static final String ENABLE_TRACK
      This command used for multitrack stream to play or pause a tranck
      See Also:

    • GET_TRACK_LIST

      public static final String GET_TRACK_LIST
      This command used to get subtracks for a stream id
      See Also:

    • TRACK_LIST

      public static final String TRACK_LIST
      This command used to send subtracks for a stream id
      See Also:

    • BITRATE_MEASUREMENT

      public static final String BITRATE_MEASUREMENT
      Notification to send measured bitrate
      See Also:

    • DATA_STORE_NOT_AVAILABLE

      public static final String DATA_STORE_NOT_AVAILABLE
      Error definition. It's sent when data store is not available. It's not available if it's closed or not available;
      See Also:

    • SERVER_ERROR_CHECK_LOGS

      public static final String SERVER_ERROR_CHECK_LOGS
      It's sent when community handler does not start streaming
      See Also:

    • VIEWER_INFO

      public static final String VIEWER_INFO
      Free text info for the viewer
      See Also:

    • LICENCE_SUSPENDED

      public static final String LICENCE_SUSPENDED
      It's sent when license is suspended
      See Also:

    • MAIN_TRACK

      public static final String MAIN_TRACK
      It's sent to determine mainTrackId if exists
      See Also:

    • MODE

      public static final String MODE
      It's sent as parameter conference mode
      See Also:

    • MCU

      public static final String MCU
      It's sent for conference in MCU mode
      See Also:

    • AMCU

      public static final String AMCU
      It's sent for conference in Audio Only MCU mode
      See Also:

    • MULTI_TRACK

      public static final String MULTI_TRACK
      It's sent for conference in MCU mode
      See Also:

    • LEGACY

      public static final String LEGACY
      It's sent for conference in legacy mode
      See Also:

    • SESSION_RESTORED_DESCRIPTION

      public static final String SESSION_RESTORED_DESCRIPTION
      It's sent for the restored webrtc publish sessions
      See Also:

    • ID_MAPPING

      public static final String ID_MAPPING
      It's the field that maps sdp mid to stream id
      See Also:

    • META_DATA

      public static final String META_DATA
      It can be used to add some meta data to a broadcast
      See Also:

    • UPDATE_STREAM_META_DATA_COMMAND

      public static final String UPDATE_STREAM_META_DATA_COMMAND
      Command to update the meta data for a broadcast
      See Also:

    • ASSIGN_VIDEO_TRACK_COMMAND

      public static final String ASSIGN_VIDEO_TRACK_COMMAND
      Command to inform AMS if a stream is pinned in conference mode
      See Also:

    • UPDATE_VIDEO_TRACK_ASSIGNMENTS_COMMAND

      public static final String UPDATE_VIDEO_TRACK_ASSIGNMENTS_COMMAND
      Command to change visible streams in conference mode, used for pagination
      See Also:

    • SET_MAX_VIDEO_TRACK_COUNT_COMMAND

      public static final String SET_MAX_VIDEO_TRACK_COUNT_COMMAND
      Command to set max video track count in conference
      See Also:

    • GET_DEBUG_INFO_COMMAND

      public static final String GET_DEBUG_INFO_COMMAND
      Command to get debug info in conference
      See Also:

    • DEBUG_INFO

      public static final String DEBUG_INFO
      Generated debug info in conference
      See Also:

    • VIDEO_TRACK_ID

      public static final String VIDEO_TRACK_ID
      Track id that is pinned for a stream
      See Also:

    • OFFSET

      public static final String OFFSET
      Start index of a list for pagination
      See Also:

    • SIZE

      public static final String SIZE
      Length of a page for pagination
      See Also:

    • MAX_TRACK_COUNT

      public static final String MAX_TRACK_COUNT
      maximum number of tracks
      See Also:

    • GET_BROADCAST_OBJECT_COMMAND

      public static final String GET_BROADCAST_OBJECT_COMMAND
      Command to get broadcast object
      See Also:

    • GET_VIDEO_TRACK_ASSIGNMENTS_COMMAND

      public static final String GET_VIDEO_TRACK_ASSIGNMENTS_COMMAND
      Command to get video track assignments
      See Also:

    • BROADCAST_OBJECT_NOTIFICATION

      public static final String BROADCAST_OBJECT_NOTIFICATION
      broadcast object notification
      See Also:

    • BROADCAST

      public static final String BROADCAST
      broadcast object constant
      See Also:

    • SEND_PUSH_NOTIFICATION_COMMAND

      public static final String SEND_PUSH_NOTIFICATION_COMMAND
      See Also:

    • REGISTER_PUSH_NOTIFICATION_TOKEN_COMMAND

      public static final String REGISTER_PUSH_NOTIFICATION_TOKEN_COMMAND
      See Also:

    • AUTH_TOKEN_NOT_VALID_ERROR_DEFINITION

      public static final String AUTH_TOKEN_NOT_VALID_ERROR_DEFINITION
      See Also:

    • PNS_REGISTRATION_TOKEN

      public static final String PNS_REGISTRATION_TOKEN
      Push Notificaiton Service Registration Token
      See Also:

    • PNS_TYPE

      public static final String PNS_TYPE
      Push Notificaiton Service type, it can fcm or apn FCM: Firebase Cloud Messaging APN: Apple Notification Service
      See Also:

    • MISSING_PARAMETER_DEFINITION

      public static final String MISSING_PARAMETER_DEFINITION
      See Also:

    • INFORMATION

      public static final String INFORMATION
      Information field in websocket communication
      See Also:

    • SUCCESS

      public static final String SUCCESS
      Success field in websocket communication. If it's value true, the operation is successful. If it's value is false, the operation is failed
      See Also:

    • PUSH_NOTIFICATION_TOPIC

      public static final String PUSH_NOTIFICATION_TOPIC
      Topic field to send push notification
      See Also:

    • SUBSCRIBER_ID_LIST_TO_NOTIFY

      public static final String SUBSCRIBER_ID_LIST_TO_NOTIFY
      Subscriber id list to send push notification
      See Also:

    • PUSH_NOTIFICATION_CONTENT

      public static final String PUSH_NOTIFICATION_CONTENT
      Push Notification Content
      See Also:

    • ROLE

      public static final String ROLE
      Participant role in the room
      See Also:

    • DISABLE_TRACKS_BY_DEFAULT

      public static final String DISABLE_TRACKS_BY_DEFAULT
      Participant role in the room
      See Also:

    • GET_SUBTRACKS_COMMAND

      public static final String GET_SUBTRACKS_COMMAND
      Command to get subtrack infos for a main track
      See Also:

    • GET_SUBTRACKS_COUNT_COMMAND

      public static final String GET_SUBTRACKS_COUNT_COMMAND
      Command to get subtrack count for a main track
      See Also:

    • SUBTRACK_LIST_NOTIFICATION

      public static final String SUBTRACK_LIST_NOTIFICATION
      subtrack (broadcast) object list notification
      See Also:

    • GET_SUBSCRIBER_LIST_SIZE

      public static final String GET_SUBSCRIBER_LIST_SIZE
      Command to get subscriber list size
      See Also:

    • SUBSCRIBER_COUNT

      public static final String SUBSCRIBER_COUNT
      subscriber count notification
      See Also:

    • GET_SUBSCRIBER_LIST

      public static final String GET_SUBSCRIBER_LIST
      Command to get subscribers for a stream
      See Also:

    • SUBSCRIBER_LIST_NOTIFICATION

      public static final String SUBSCRIBER_LIST_NOTIFICATION
      subscribers list notification
      See Also:

    • STATUS

      public static final String STATUS
      status field in websocket communication
      See Also:

    • SORT_BY

      public static final String SORT_BY
      sort field used for sorting subtracks
      See Also:

    • ORDER_BY

      public static final String ORDER_BY
      order (asc, desc) field used for ordering subtracks
      See Also:

    • COUNT

      public static final String COUNT
      See Also:

    • SUBTRACK_COUNT_NOTIFICATION

      public static final String SUBTRACK_COUNT_NOTIFICATION
      subtrack (broadcast) object count notification
      See Also:

    • SUBTRACK_LIST

      public static final String SUBTRACK_LIST
      subtrack (broadcast) object list
      See Also:

    • SUBCRIBER_LIST

      public static final String SUBCRIBER_LIST
      subscribers list
      See Also:

    • NO_PACKET_RECEIVED_FOR_TIMEOUT_DURATION

      public static final String NO_PACKET_RECEIVED_FOR_TIMEOUT_DURATION
      This is the error definition that is sent when the stream does not get video or audio packet for the timeout duration. Currently it's implemented for WebRTC ingest
      See Also:

    • MAINTRACK_DB_OPERATION_FAILED

      public static final String MAINTRACK_DB_OPERATION_FAILED
      This is the error definition that is sent when mainTrack cannot be created or updated in publishing process.
      See Also:

    • USER_PUBLISH_ID

      public static final String USER_PUBLISH_ID
      This is passed in play websocket method to define the publisher stream id (if available) which uses same websocket channel with player For example in conference case a participant use same websocket to publish its stream and to play the others
      See Also:

    • SUBTRACK_ADDED

      public static final String SUBTRACK_ADDED
      Notification to notify a new subtrack addition to a main track
      See Also:

    • SUBTRACK_REMOVED

      public static final String SUBTRACK_REMOVED
      Notification to notify a new subtrack removal to a main track
      See Also:

    • STREAM_NOT_EXIST_OR_NOT_STREAMING_DEFINITION

      public static final String STREAM_NOT_EXIST_OR_NOT_STREAMING_DEFINITION
      This is the error definition that is sent when the stream does not exist or not streaming
      See Also:

    • WEBRTC_NOT_ENABLED_TO_PLAYBACK_DEFINITION

      public static final String WEBRTC_NOT_ENABLED_TO_PLAYBACK_DEFINITION
      This is the error definition that is sent when the stream exits but not available as WebRTC because webrtc is not enabled
      See Also:

    • STREAMING_STARTS_SOON_DEFINITION

      public static final String STREAMING_STARTS_SOON_DEFINITION
      This is the definition that is sent when the is about to start for auto/start stop streams
      See Also:

  • Constructor Details

    • WebSocketConstants

      private WebSocketConstants()