com.smaxe.uv.client.rtmfp

Interface INetStream

All Superinterfaces:

INetStream

public interface INetStream
extends INetStream

INetStream - RTMFP connection stream (replica of ActionScript's NetStream class interface).

Version:

2.0.0

Author:

Andrei Sochirca

See Also:

JUV RTMFP Client

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INetStream.IAcknowledgement IAcknowledgement - MediaData acknowledgement interface.

Nested classes/interfaces inherited from interface com.smaxe.uv.client.rtmp.INetStream

INetStream.IListener, INetStream.Info, INetStream.ListenerAdapter

Field Summary

Fields inherited from interface com.smaxe.uv.client.rtmp.INetStream

APPEND, CLEAR_FAILED, CLEAR_SUCCESS, DATA_START, FAILED, INVALID_ARGUMENT, LIVE, PAUSE_NOTIFY, PLAY_COMPLETE, PLAY_FAILED, PLAY_FILE_STRUCTURE_INVALID, PLAY_INSUFFICIENT_BW, PLAY_NO_SUPPORTED_TRACK_FOUND, PLAY_PUBLISH_NOTIFY, PLAY_RESET, PLAY_START, PLAY_STOP, PLAY_STREAM_NOT_FOUND, PLAY_SWITCH, PLAY_UNPUBLISH_NOTIFY, PUBLISH_BADNAME, PUBLISH_START, RECORD, RECORD_FAILED, RECORD_NOACCESS, RECORD_START, RECORD_STOP, SEEK_FAILED, SEEK_NOTIFY, UNPAUSE_NOTIFY, UNPUBLISH_SUCCESS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	audioReliable() For RTMFP connections, specifies whether audio is sent with full reliability.
void	audioReliable(boolean reliable) For RTMFP connections, specifies whether audio is sent with full reliability.
boolean	audioSampleAccess() For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream.
void	audioSampleAccess(boolean access) For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream.
boolean	dataReliable() For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability.
void	dataReliable(boolean reliable) For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability.
java.lang.String	farID() For RTMFP connections, the identifier of the far end that is connected to this NetStream instance.
java.lang.String	farNonce() For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection.
INetStream.IAcknowledgement	getAcknowledgement()
NetStreamInfo	info() Returns a NetStreamInfo object whose properties contain statistics about the quality of service.
boolean	multicastAvailabilitySendToAll() For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are sent to all peers or to just one peer.
void	multicastAvailabilitySendToAll(boolean sendToAll) For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are sent to all peers or to just one peer.
int	multicastAvailabilityUpdatePeriod() For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that the local node has new peer-to-peer multicast media fragments available.
void	multicastAvailabilityUpdatePeriod(int period) For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that the local node has new peer-to-peer multicast media fragments available.
int	multicastFetchPeriod() For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer multicast media fragment is available and when it tries to fetch it from a peer.
void	multicastFetchPeriod(int period) For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer multicast media fragment is available and when it tries to fetch it from a peer.
NetStreamMulticastInfo	multicastInfo() For RTMFP connections, returns a NetStreamMulticastInfo object whose properties contain statistics about the quality of service.
int	multicastPushNeighborLimit() For RTMFP connections, specifies the maximum number of peers to which to proactively push multicast media.
void	multicastPushNeighborLimit(int limit) For RTMFP connections, specifies the maximum number of peers to which to proactively push multicast media.
int	multicastRelayMarginDuration() For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains available to send to peers that request it beyond a specified duration.
void	multicastRelayMarginDuration(int duration) For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains available to send to peers that request it beyond a specified duration.
int	multicastWindowDuration() For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly window.
void	multicastWindowDuration(int duration) For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly window.
java.lang.String	nearNonce() For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection.
java.util.List<INetStream>	peerStreams() An object that holds all of the subscribing NetStream instances that are listening to this publishing NetStream instance.
void	setAcknowledgement(INetStream.IAcknowledgement ack) Sets ack.
boolean	videoReliable() For RTMFP connections, specifies whether video is sent with full reliability.
void	videoReliable(boolean reliable) For RTMFP connections, specifies whether video is sent with full reliability.
boolean	videoSampleAccess() For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream.
void	videoSampleAccess(boolean access) For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream.

Methods inherited from interface com.smaxe.uv.client.rtmp.INetStream

addEventListener, attachAudio, attachCamera, bufferLength, bufferSize, bufferTime, bufferTime, bytesLoaded, bytesTotal, clearBuffer, client, client, close, currentFPS, getCamera, getInfo, getMicrophone, getVideo, liveDelay, objectEncoding, pause, play, publish, receiveAudio, receiveVideo, removeEventListener, resume, seek, send, time, togglePause

Method Detail

getAcknowledgement

INetStream.IAcknowledgement getAcknowledgement()

Returns:

ack

setAcknowledgement

void setAcknowledgement(INetStream.IAcknowledgement ack)

Sets ack.

Parameters:

ack -

audioReliable

boolean audioReliable()

For RTMFP connections, specifies whether audio is sent with full reliability. When true, all audio transmitted over this NetStream is fully reliable. When false, the audio transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. You can use the false value to reduce latency at the expense of audio quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Returns:

audio reliable flag

audioReliable

void audioReliable(boolean reliable)

For RTMFP connections, specifies whether audio is sent with full reliability. When true, all audio transmitted over this NetStream is fully reliable. When false, the audio transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. You can use the false value to reduce latency at the expense of audio quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Parameters:

reliable -

audioSampleAccess

boolean audioSampleAccess()

For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream. When false, subscriber attempts to capture the audio stream show permission errors.

Returns:

audio sample access flag

audioSampleAccess

void audioSampleAccess(boolean access)

For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream. When false, subscriber attempts to capture the audio stream show permission errors.

Parameters:

access -

dataReliable

boolean dataReliable()

For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability. When true, NetStream.send() calls that are transmitted over this NetStream are fully reliable. When false, NetStream.send() calls are not transmitted with full reliability, but instead are retransmitted for a limited time and then dropped. You can set this value to false to reduce latency at the expense of data quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Returns:

data reliable flag

dataReliable

void dataReliable(boolean reliable)

For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability. When true, NetStream.send() calls that are transmitted over this NetStream are fully reliable. When false, NetStream.send() calls are not transmitted with full reliability, but instead are retransmitted for a limited time and then dropped. You can set this value to false to reduce latency at the expense of data quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Parameters:

reliable -

farID

java.lang.String farID()

For RTMFP connections, the identifier of the far end that is connected to this NetStream instance.

Returns:

far id

farNonce

java.lang.String farNonce()

For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection. This value appears to the other end of the stream as its nearNonce value.

Returns:

far nonce

info

NetStreamInfo info()

Returns a NetStreamInfo object whose properties contain statistics about the quality of service. The object is a snapshot of the current state.

Returns:

net stream info

multicastAvailabilitySendToAll

boolean multicastAvailabilitySendToAll()

For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are sent to all peers or to just one peer. A value of true specifies that the messages are sent to all peers once per specified interval. A value of false specifies that the messages are sent to just one peer per specified interval. The interval is determined by the multicastAvailabilityUpdatePeriod property.

Returns:

multicast availability send to all flag

multicastAvailabilitySendToAll

void multicastAvailabilitySendToAll(boolean sendToAll)

For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are sent to all peers or to just one peer. A value of true specifies that the messages are sent to all peers once per specified interval. A value of false specifies that the messages are sent to just one peer per specified interval. The interval is determined by the multicastAvailabilityUpdatePeriod property.

Parameters:

sendToAll -

multicastAvailabilityUpdatePeriod

int multicastAvailabilityUpdatePeriod()

For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that the local node has new peer-to-peer multicast media fragments available.
Larger values can increase batching efficiency and reduce control overhead, but they can lower quality on the receiving end by reducing the amount of time available to retrieve fragments before they are out-of-window. Lower values can reduce latency and improve quality, but they increase control overhead.

Returns:

availability update period

multicastAvailabilityUpdatePeriod

void multicastAvailabilityUpdatePeriod(int period)

For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that the local node has new peer-to-peer multicast media fragments available.
Larger values can increase batching efficiency and reduce control overhead, but they can lower quality on the receiving end by reducing the amount of time available to retrieve fragments before they are out-of-window. Lower values can reduce latency and improve quality, but they increase control overhead.

Parameters:

period -

multicastFetchPeriod

int multicastFetchPeriod()

For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer multicast media fragment is available and when it tries to fetch it from a peer. This value gives an opportunity for the fragment to be proactively pushed to the local node before a fetch from a peer is attempted. It also allows for more than one peer to announce availability of the fragment, so the fetch load can be spread among multiple peers.
Larger values can improve load balancing and fairness in the peer-to-peer mesh, but reduce the available multicastWindowDuration and increase latency. Smaller values can reduce latency when fetching is required, but might increase duplicate data reception and reduce peer-to-peer mesh load balance.

Returns:

fetch period

multicastFetchPeriod

void multicastFetchPeriod(int period)

For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer multicast media fragment is available and when it tries to fetch it from a peer. This value gives an opportunity for the fragment to be proactively pushed to the local node before a fetch from a peer is attempted. It also allows for more than one peer to announce availability of the fragment, so the fetch load can be spread among multiple peers.
Larger values can improve load balancing and fairness in the peer-to-peer mesh, but reduce the available multicastWindowDuration and increase latency. Smaller values can reduce latency when fetching is required, but might increase duplicate data reception and reduce peer-to-peer mesh load balance.

Parameters:

period -

multicastPushNeighborLimit

int multicastPushNeighborLimit()

For RTMFP connections, specifies the maximum number of peers to which to proactively push multicast media.

Returns:

limit

multicastPushNeighborLimit

void multicastPushNeighborLimit(int limit)

For RTMFP connections, specifies the maximum number of peers to which to proactively push multicast media.

Parameters:

limit -

multicastRelayMarginDuration

int multicastRelayMarginDuration()

For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains available to send to peers that request it beyond a specified duration. The duration is specified by the multicastWindowDuration property.

Returns:

duration

multicastRelayMarginDuration

void multicastRelayMarginDuration(int duration)

For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains available to send to peers that request it beyond a specified duration. The duration is specified by the multicastWindowDuration property.

Parameters:

duration -

multicastWindowDuration

int multicastWindowDuration()

For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly window. Shorter values reduce latency but may reduce quality by not allowing enough time to obtain all of the fragments. Conversely, larger values may increase quality by providing more time to obtain all of the fragments, with a corresponding increase in latency.

Returns:

duration

multicastWindowDuration

void multicastWindowDuration(int duration)

For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly window. Shorter values reduce latency but may reduce quality by not allowing enough time to obtain all of the fragments. Conversely, larger values may increase quality by providing more time to obtain all of the fragments, with a corresponding increase in latency.

Parameters:

duration -

multicastInfo

NetStreamMulticastInfo multicastInfo()

For RTMFP connections, returns a NetStreamMulticastInfo object whose properties contain statistics about the quality of service. The object is a snapshot of the current state.

Returns:

multicast info

nearNonce

java.lang.String nearNonce()

For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection. This value appears to the other end of the stream as its farNonce value.

Returns:

near nonce

peerStreams

java.util.List<INetStream> peerStreams()

An object that holds all of the subscribing NetStream instances that are listening to this publishing NetStream instance.

Returns:

peer streams

videoReliable

boolean videoReliable()

For RTMFP connections, specifies whether video is sent with full reliability. When true, all video transmitted over this NetStream is fully reliable. When false, the video transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. You can use the false value to reduce latency at the expense of video quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Returns:

video reliable flag

videoReliable

void videoReliable(boolean reliable)

For RTMFP connections, specifies whether video is sent with full reliability. When true, all video transmitted over this NetStream is fully reliable. When false, the video transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. You can use the false value to reduce latency at the expense of video quality.
If you try to set this property to false on a network protocol that does not support partial reliability, the attempt is ignored and the property is set to true.

Parameters:

reliable -

videoSampleAccess

boolean videoSampleAccess()

For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream. When false, subscriber attempts to capture the video stream show permission errors.

Returns:

video sample access flag

videoSampleAccess

void videoSampleAccess(boolean access)

For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream. When false, subscriber attempts to capture the video stream show permission errors.

Parameters:

access -