VCDoc
Class Tree

Name
  unaConfRTPclient.TunaConfRTPclient

Class Hierarchy
  / unavclInOutPipe / TComponent / TPersistent / TObject

Description
 

A simple but powerfull conference client.

Members
  Fields
 
Field Description

Methods
 
Method Description
unavclInOutPipe.addConsumer Adds new consumer for the pipe.
unavclInOutPipe.addProvider Adds new provider for the pipe.
unavclInOutPipe.AfterConstruction Creates list of consumers and providers, internal critical section and data proxy thread.
unavclInOutPipe.applyFormat Applies new format of the data stream.
unavclInOutPipe.BeforeDestruction Destroys the pipe.
unavclInOutPipe.checkIfAutoActivate Checks if autoActivate property is True and activates/deactivates consumers if yes.
unavclInOutPipe.checkIfFormatProvider Checks if component is format provider and applies format to consumer if it is (and format was not applied before).
unavclInOutPipe.clearFormatCRC Forces component to assign its format to consumers (if isFormatProvider is True).
unavclInOutPipe.close Closes the pipe.
unavclInOutPipe.doAddConsumer Adds new consumer for the pipe.
unavclInOutPipe.doAddProvider Assigns new provider for the pipe.
unavclInOutPipe.doBeforeAfterFC Calls f_beforeFormatChange or f_afterFormatChange if assigned.
unavclInOutPipe.doClose Closes the pipe.
unavclInOutPipe.doGetPosition Implements positions retrieval routine.
unavclInOutPipe.doOpen Opens the pipe.
unavclInOutPipe.doRead Reads data from the pipe.
unavclInOutPipe.doRemoveConsumer Removes consumer from the pipe.
unavclInOutPipe.doRemoveProvider Removes one of pipe's providers.
unavclInOutPipe.doSetActive Sets active state of the pipe.
unavclInOutPipe.doSetEnableDP Sets enableDataProcessing value.
unavclInOutPipe.doWrite Writes data into the pipe.
unavclInOutPipe.enter Enters the internal critical section.
unavclInOutPipe.getAvailableDataLen Returns data size available in the pipe (bytes).
unavclInOutPipe.getConsumerIndex Returns index of consumer.
unavclInOutPipe.getFormatExchangeData Fills the format of the data stream.
unavclInOutPipe.getPosition Returns position in stream.
unavclInOutPipe.getProviderIndex Returns index of provider.
unavclInOutPipe.incInOutBytes Increments (or decrements in/outBytes property by delta.
unavclInOutPipe.isActive Returns component's active state.
unavclInOutPipe.leaveRO Leaves the internal critical section.
unavclInOutPipe.leaveWO  
unavclInOutPipe.Loaded Usually creates an internal device of the pipe, and activates the component if needed.
unavclInOutPipe.Notification IDE/VCL notification for components removal/insertion.
unavclInOutPipe.notifyConsumers Notify all consumers there is no more such provider (self).
unavclInOutPipe.notifyProviders Notify all providers there is new consumer (self), or consumer is removed (value = nil).
unavclInOutPipe.onNewData Processes new data available from the pipe.
unavclInOutPipe.open Opens the pipe.
unavclInOutPipe.READ Reads data as a AnsiString.
unavclInOutPipe.READ If you did not specify the consumer for the pipe, you must call
unavclInOutPipe.removeConsumer Removes consumer from the pipe.
unavclInOutPipe.removeProvider Removes one of pipe's providers.
unavclInOutPipe.WRITE Writes data into the pipe.
unavclInOutPipe.WRITE Writes data into the pipe.
connect Connects to server.
connect Connects to server. Constructs URI property and call open().
Create Creates an RTP Conference client.
createDummy Creates dummy RTP Conference client (mostly for debug).
Destroy Destroys RTP Conference client.
disconnect Disconnect from server.
doClose Closes the pipe.
doOpen Opens the pipe.
doRead Reads data from the pipe.
doWrite Writes data into the pipe.
feedOut Must be called right after new audio chunk was released from WaveOut queue.
getAvailableDataLen Returns data size available in the pipe (bytes).
getConnectStatus Returns status of client connection.
getInStreamSSRC Returns SSRC of remote user.
getMicVolume  
getPlaybackVolume  
getRemoteName Returns CNAME or remote user.
isActive Returns component's active state.
onDecodedData  
onEncodedData  
setEncoding Specifies new sps/encoding to use.

Properties
 
Property Description
unavclInOutPipe.active Returns or sets the active state of the pipe.
unavclInOutPipe.autoActivate When True tells the component it must activate consumer (if any)
unavclInOutPipe.availableDataLenIn Returns data written into but not yet processed by the pipe.
unavclInOutPipe.availableDataLenOut Returns data size available to read from the pipe.
unavclInOutPipe.closing True if component is being closed.
unavclInOutPipe.consumer Specifies the consumer of component.
unavclInOutPipe.consumerCount Number of consumers.
unavclInOutPipe.consumers Returns consumer.
unavclInOutPipe.dumpInput Specifies the file name to store the stream into.
unavclInOutPipe.dumpOutput Specifies the file name to store the stream into.
unavclInOutPipe.enableDataProcessing Specifies whether the component would perform any data processing.
unavclInOutPipe.enableDataProxy Data will be placed to proxy thread before processing.
unavclInOutPipe.ignoreProviderOptions Specifies which proviers options will be ignored.
unavclInOutPipe.inBytes Number of bytes received by the pipe.
unavclInOutPipe.isFormatProvider When True the component will assign stream format to the consumer (if any).
unavclInOutPipe.onDataAvailable This event is fired every time component has produced or received new chunk of data.
unavclInOutPipe.onDataDSP This event is fired every time component has produced or received new
unavclInOutPipe.onFormatChangeAfter This event is fired after new format was applied to a pipe.
unavclInOutPipe.onFormatChangeBefore This event is fired before new format is about to be applied to a pipe.
unavclInOutPipe.opt Internal.
unavclInOutPipe.outBytes Number of bytes produced by the pipe.
unavclInOutPipe.position Current position in stream (if applicable).
unavclInOutPipe.providerCount Number of providers.
unavclInOutPipe.providerOneAndOnly Returns first provider of a component (if any).
unavclInOutPipe.providers Returns provider.
unavclInOutPipe._consumers List of consumers.
unavclInOutPipe._providers List of providers.
bind2ip Bind to this interface (default is 0.0.0.0, means bind to all interfaces).
bind2port Bind to this local port (default is 0, means auto-select first available port).
bw_in Input bandwidth in bits per second.
bw_out Output bandwidth in bits per second.
channelInfo Channel info
connected True when connection was established.
dsp Speex DSP object. *internal*
dsp_aec SpeexDSP: acoustic echo cancellation ON/OFF
dsp_agc SpeexDSP: auto-gain control ON/OFF
dsp_ns SpeexDSP: noise suppression ON/OFF
dsp_vad SpeexDSP: voice activity detection ON/OFF
encoding Encoding type. Must be one of supported c_rtp_enc_XXXX.
error Last error code.
mixer Mixer object *use as read-only*
onConnect Fired when client is connected.
onDisconnect Fired when client is disconnected.
payload Payload type. *internal*
playbackEnabled Enable/disable playback.
playbackLevel Modify playback level (from 0 to 100). Default is 100 (no modify).
recordingEnabled Enable/disable recording.
recordingLevel Modify recording level (from 0 to 100). Default is 100 (no modify).
roomName Room Name.
sps Sampling rate. Must be 8000, 16000 or 32000.
srvCNAME CNAME of server
srvMasterkey Server master key (write-only).
srvSSRC SSRC of server
SSRC Client's RTP SSRC
trans RTP/RTCP transmitter.
URI URI, like:
userName Local user Name.

Events
 
Event Description


(c) 2001-2011 Lake of Soft
Created with DelphiCodeToDoc.