com.smaxe.me.uv.client
Class NetConnection.Configuration

java.lang.Object
  extended by com.smaxe.me.uv.client.NetConnection.Configuration
Enclosing class:
NetConnection

public static final class NetConnection.Configuration
extends java.lang.Object

Configuration - NetConnection configuration constants.


Field Summary
static java.lang.String AUDIO_CODECS
          AUDIO_CODECS - "audioCodecs" : audio codecs - used as a RTMP server connection parameter.
static java.lang.String CAPABILITIES
          CAPABILITIES - "capabilities" : capabilities - used as a RTMP server connection parameter.
static java.lang.String CONNECTION_PARAMETERS
          CONNECTION_PARAMETERS - "connectionParameters": socket connection parameters, i.e.
static java.lang.String ENABLE_ACKNOWLEDGEMENT_EVENT_NOTIFICATION
          ENABLE_ACKNOWLEDGEMENT_EVENT_NOTIFICATION - "enableAcknowledgementEventNotification": enables "NetConnection.Connect.Bandwidth" event notification on every 'acknowledgement' message received from the server (default: false).
static java.lang.String ENABLE_MEDIA_STREAM_ABSOLUTE_TIMESTAMP
          ENABLE_MEDIA_STREAM_ABSOLUTE_TIMESTAMP - "enableMediaStreamAbsoluteTimestamp": (default: false).
static java.lang.String ENABLE_RTMPT_FCS_IDENT
          ENABLE_RTMPT_FCS_IDENT - "enableRtmptFcsIdent": enables "/fcs/ident2" message sent at start of the RTMPT session (default: false)
static java.lang.String FLASH_VER
          FLASH_VER - "flashVer" : flash version - used as a RTMP server connection parameter.
static java.lang.String FPAD
          FPAD - "fpad" : fpad value - used as a RTMP server connection parameter.
static java.lang.String HANDSHAKE_TIMEOUT
          HANDSHAKE_TIMEOUT - "handshakeTimeout" : timeout (in seconds) for the handshake phase of the protocol (default: 30 seconds).
static java.lang.String INACTIVITY_TIMEOUT
          INACTIVITY_TIMEOUT - "inactivityTimeout" : timeout (in seconds) for rtmp protocol connection, i.e. if data is not received during this timeout, the connection is considered disconnected (default: -1, disabled).
static java.lang.String IO_TIMEOUT
          IO_TIMEOUT - "IOTimeout" : I/O timeout (in milliseconds) (default: 50 milliseconds)
static java.lang.String LOGGER
          LOGGER - "logger" : responsible for logging.
static java.lang.String MAX_RTMP_PACKET_SIZE
          MAX_RTMP_PACKET_SIZE - "maxRtmpPacketSize": max RTMP packet size that is processed by the library (default: 1MiB).
static java.lang.String MAX_UPLOAD_BANDWIDTH
          MAX_UPLOAD_BANDWIDTH - "maxUploadBandwidth": max upload bandwidth (default: -1) Note:
- The library will try to do not exceed max value by sending large video/flv frames in chunks.
static java.lang.String METHOD_INVOKER
          METHOD_INVOKER - "methodInvoker" : responsible for methods invocation.
static java.lang.String OBJECT_CREATOR
          OBJECT_CREATOR - "objectCreator" : responsible for creating custom objects.
static java.lang.String PAGE_URL
          PAGE_URL - "pageUrl" : page url - used as a RTMP server connection parameter.
static java.lang.String RECEIVE_BUFFER_SIZE
          RECEIVE_BUFFER_SIZE - "rcvBufSize" : receive buffer size in bytes (default: 8KiB).
static java.lang.String SEND_BUFFER_SIZE
          SEND_BUFFER_SIZE - "sndBufSize" : send buffer size in bytes (default: 8KiB).
static java.lang.String SET_FIRST_MEDIA_FRAME_RTIME_TO_ZERO
          SET_FIRST_MEDIA_FRAME_RTIME_TO_ZERO - "setFirstMediaFrameRtimeToZero": (default: true).
static java.lang.String SOCKET_CONNECTION_DELAY
          SOCKET_CONNECTION_DELAY - "socketConnectionDelay": 'Delay' socket option (detault: 0).
static java.lang.String SOCKET_CONNECTION_KEEP_ALIVE
          SOCKET_CONNECTION_KEEP_ALIVE - "socketConnectionKeepAlive": 'Keep Alive' socket option (detault: 1).
static java.lang.String SOCKET_CONNECTION_LINGER
          SOCKET_CONNECTION_LINGER - "socketConnectionLinger": 'Linger' socket option (default: 5).
static java.lang.String SOCKET_CONNECTION_RCVBUF
          SOCKET_CONNECTION_RCVBUF - "socketConnectionRcvBuf": 'Receive Buffer Size' socket option (default: 8KB).
static java.lang.String SOCKET_CONNECTION_SNDBUF
          SOCKET_CONNECTION_SNDBUF - "socketConnectionSndBuf": 'Send Buffer Size' socket option (default: 8KB).
static java.lang.String STREAM_BUFFER_SIZE
          STREAM_BUFFER_SIZE - "streamBufSize" : audio/video stream buffer size in bytes (default: 32KiB).
static java.lang.String SWF_URL
          SWF_URL - "swfUrl" : swf url - used as a RTMP server connection parameter.
static java.lang.String USE_HTTP_CONNECTION
          USE_HTTP_CONNECTION - "useHttpConnection": use http connection (for RTMPT protocols) flag (default: false)
static java.lang.String VIDEO_CODECS
          VIDEO_CODECS - "videoCodecs" : video codecs - used as a RTMP server connection parameter.
static java.lang.String VIDEO_FUNCTION
          VIDEO_FUNCTION - "videoFunction" : video function - used as a RTMP server connection parameter.
static java.lang.String WINDOW_ACKNOWLEDGEMENT_SIZE
          WINDOW_ACKNOWLEDGEMENT_SIZE - "windowAcknowledgementSize": 'Window Acknowledgement Size' values defines 'Acknowledgement' event notification period in bytes read by server (default: 128KiB).
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IO_TIMEOUT

public static final java.lang.String IO_TIMEOUT
IO_TIMEOUT - "IOTimeout" : I/O timeout (in milliseconds) (default: 50 milliseconds)

See Also:
Constant Field Values

RECEIVE_BUFFER_SIZE

public static final java.lang.String RECEIVE_BUFFER_SIZE
RECEIVE_BUFFER_SIZE - "rcvBufSize" : receive buffer size in bytes (default: 8KiB).

Note:
- This buffer is used to parse incoming RTMP messages, i.e. socket content is written to the 'rcvBuf' for parsing.
- If packet size is greater than 'rcvBufSize' a new temporary buffer is created to store big RTMP message (the respective INFO event is logged, so you can adjust 'rcvBufSize' to avoid too many temporary buffers creation).
- If packet size is greater that MAX_RTMP_PACKET_SIZE then packet is discarded (the respective WARN event is logged).

See Also:
Constant Field Values

SEND_BUFFER_SIZE

public static final java.lang.String SEND_BUFFER_SIZE
SEND_BUFFER_SIZE - "sndBufSize" : send buffer size in bytes (default: 8KiB).

Note:
- This buffer is used to prepare outgoing RTMP messages stream.

See Also:
Constant Field Values

STREAM_BUFFER_SIZE

public static final java.lang.String STREAM_BUFFER_SIZE
STREAM_BUFFER_SIZE - "streamBufSize" : audio/video stream buffer size in bytes (default: 32KiB).

Note:
- This buffer is used to keep media data stream.

See Also:
Constant Field Values

CONNECTION_PARAMETERS

public static final java.lang.String CONNECTION_PARAMETERS
CONNECTION_PARAMETERS - "connectionParameters": socket connection parameters, i.e. "socket://host:port[parameters]"

See Also:
Constant Field Values

SOCKET_CONNECTION_DELAY

public static final java.lang.String SOCKET_CONNECTION_DELAY
SOCKET_CONNECTION_DELAY - "socketConnectionDelay": 'Delay' socket option (detault: 0).

See Also:
Constant Field Values

SOCKET_CONNECTION_KEEP_ALIVE

public static final java.lang.String SOCKET_CONNECTION_KEEP_ALIVE
SOCKET_CONNECTION_KEEP_ALIVE - "socketConnectionKeepAlive": 'Keep Alive' socket option (detault: 1).

See Also:
Constant Field Values

SOCKET_CONNECTION_LINGER

public static final java.lang.String SOCKET_CONNECTION_LINGER
SOCKET_CONNECTION_LINGER - "socketConnectionLinger": 'Linger' socket option (default: 5).

See Also:
Constant Field Values

SOCKET_CONNECTION_RCVBUF

public static final java.lang.String SOCKET_CONNECTION_RCVBUF
SOCKET_CONNECTION_RCVBUF - "socketConnectionRcvBuf": 'Receive Buffer Size' socket option (default: 8KB).

See Also:
Constant Field Values

SOCKET_CONNECTION_SNDBUF

public static final java.lang.String SOCKET_CONNECTION_SNDBUF
SOCKET_CONNECTION_SNDBUF - "socketConnectionSndBuf": 'Send Buffer Size' socket option (default: 8KB).

See Also:
Constant Field Values

USE_HTTP_CONNECTION

public static final java.lang.String USE_HTTP_CONNECTION
USE_HTTP_CONNECTION - "useHttpConnection": use http connection (for RTMPT protocols) flag (default: false)

See Also:
Constant Field Values

ENABLE_ACKNOWLEDGEMENT_EVENT_NOTIFICATION

public static final java.lang.String ENABLE_ACKNOWLEDGEMENT_EVENT_NOTIFICATION
ENABLE_ACKNOWLEDGEMENT_EVENT_NOTIFICATION - "enableAcknowledgementEventNotification": enables "NetConnection.Connect.Bandwidth" event notification on every 'acknowledgement' message received from the server (default: false).

See Also:
Constant Field Values

ENABLE_MEDIA_STREAM_ABSOLUTE_TIMESTAMP

public static final java.lang.String ENABLE_MEDIA_STREAM_ABSOLUTE_TIMESTAMP
ENABLE_MEDIA_STREAM_ABSOLUTE_TIMESTAMP - "enableMediaStreamAbsoluteTimestamp": (default: false).

Note:
- If disabled then MediaData#rtime is sent as relative timestamp.
- If enabled then MediaData#rtime is sent as relative timestamp only if MediaData#timestamp is less than zero otherwise MediaData#timestamp is sent using absolute stream timestamp mode.

See Also:
Constant Field Values

ENABLE_RTMPT_FCS_IDENT

public static final java.lang.String ENABLE_RTMPT_FCS_IDENT
ENABLE_RTMPT_FCS_IDENT - "enableRtmptFcsIdent": enables "/fcs/ident2" message sent at start of the RTMPT session (default: false)

See Also:
Constant Field Values

HANDSHAKE_TIMEOUT

public static final java.lang.String HANDSHAKE_TIMEOUT
HANDSHAKE_TIMEOUT - "handshakeTimeout" : timeout (in seconds) for the handshake phase of the protocol (default: 30 seconds).

See Also:
Constant Field Values

INACTIVITY_TIMEOUT

public static final java.lang.String INACTIVITY_TIMEOUT
INACTIVITY_TIMEOUT - "inactivityTimeout" : timeout (in seconds) for rtmp protocol connection, i.e. if data is not received during this timeout, the connection is considered disconnected (default: -1, disabled).

See Also:
Constant Field Values

MAX_RTMP_PACKET_SIZE

public static final java.lang.String MAX_RTMP_PACKET_SIZE
MAX_RTMP_PACKET_SIZE - "maxRtmpPacketSize": max RTMP packet size that is processed by the library (default: 1MiB).

Note:
- This artificial limit was introduced to avoid too big packet sizes that can lead to the OutOfMemoryException or other bad behaviour.
- If packet size is greater that MAX_RTMP_PACKET_SIZE then packet is discarded (the respective WARN event is logged, so you have to adjust the parameter).

See Also:
Constant Field Values

MAX_UPLOAD_BANDWIDTH

public static final java.lang.String MAX_UPLOAD_BANDWIDTH
MAX_UPLOAD_BANDWIDTH - "maxUploadBandwidth": max upload bandwidth (default: -1)

Note:
- The library will try to do not exceed max value by sending large video/flv frames in chunks.
- The library interlaces audio/video packets if 'max upload bandwidth' is positive.

See Also:
Constant Field Values

SET_FIRST_MEDIA_FRAME_RTIME_TO_ZERO

public static final java.lang.String SET_FIRST_MEDIA_FRAME_RTIME_TO_ZERO
SET_FIRST_MEDIA_FRAME_RTIME_TO_ZERO - "setFirstMediaFrameRtimeToZero": (default: true).

See Also:
Constant Field Values

WINDOW_ACKNOWLEDGEMENT_SIZE

public static final java.lang.String WINDOW_ACKNOWLEDGEMENT_SIZE
WINDOW_ACKNOWLEDGEMENT_SIZE - "windowAcknowledgementSize": 'Window Acknowledgement Size' values defines 'Acknowledgement' event notification period in bytes read by server (default: 128KiB).

See Also:
Constant Field Values

FPAD

public static final java.lang.String FPAD
FPAD - "fpad" : fpad value - used as a RTMP server connection parameter.

See Also:
Constant Field Values

PAGE_URL

public static final java.lang.String PAGE_URL
PAGE_URL - "pageUrl" : page url - used as a RTMP server connection parameter.

See Also:
Constant Field Values

SWF_URL

public static final java.lang.String SWF_URL
SWF_URL - "swfUrl" : swf url - used as a RTMP server connection parameter.

See Also:
Constant Field Values

FLASH_VER

public static final java.lang.String FLASH_VER
FLASH_VER - "flashVer" : flash version - used as a RTMP server connection parameter.

See Also:
Constant Field Values

VIDEO_CODECS

public static final java.lang.String VIDEO_CODECS
VIDEO_CODECS - "videoCodecs" : video codecs - used as a RTMP server connection parameter.

See Also:
Constant Field Values

AUDIO_CODECS

public static final java.lang.String AUDIO_CODECS
AUDIO_CODECS - "audioCodecs" : audio codecs - used as a RTMP server connection parameter.

See Also:
Constant Field Values

VIDEO_FUNCTION

public static final java.lang.String VIDEO_FUNCTION
VIDEO_FUNCTION - "videoFunction" : video function - used as a RTMP server connection parameter.

See Also:
Constant Field Values

CAPABILITIES

public static final java.lang.String CAPABILITIES
CAPABILITIES - "capabilities" : capabilities - used as a RTMP server connection parameter.

See Also:
Constant Field Values

METHOD_INVOKER

public static final java.lang.String METHOD_INVOKER
METHOD_INVOKER - "methodInvoker" : responsible for methods invocation.

See Also:
Constant Field Values

OBJECT_CREATOR

public static final java.lang.String OBJECT_CREATOR
OBJECT_CREATOR - "objectCreator" : responsible for creating custom objects.

See Also:
Constant Field Values

LOGGER

public static final java.lang.String LOGGER
LOGGER - "logger" : responsible for logging.

See Also:
Constant Field Values