VCDoc - TunaConfRTPserver

VCDoc

Class Tree

Name

unaConfRTPserver.TunaConfRTPserver

Class Hierarchy

/ unavclInOutPipe / TComponent / TPersistent / TObject

Description

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.
Create	Creates server component.
Destroy	Destroys server component.
doClose	Closes the server.
doConn	Fired when new user is connected or old user is disconnected.
doOpen	Stratups the server.
doRead	Does nothing.
doRoomAddRemove	Fired when new room is created or old room is removed.
doUserVerify	Virifies if user is granted to join the room.
doWrite	Does nothing.
getAvailableDataLen	Does nothing.
idle	Fired from context of idle thread.
isActive	Returns component's active state.
roomAdd	Adds new room.
roomByIDAcquire
roomByIndexAcquire	Locks room by index.
roomByUserIDAcquire
roomDrop	Removes a room. All users from this room will be disconnected from server.
roomGetName	Returns room name.
roomGetNumUsers
roomResolveName	Internal.
roomShutdown	Closes a room.
roomShutdown	Closes the room and disconnects all users joined to it.
roomStartup	Re-opens a room.
sendSrvCmd	Sends a command to client.
transPacket	Sends a packet to all users in a room.
userAddAcquire
userByIDAcquire
userByIndexAcquire
userDrop
userDrop
userGetName	Returns user name.

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.
autoCreateRooms	Automatically create rooms of users' request.
autoRemoveRooms	When set to true, causes server to remove rooms being abandoned for some time.
bind2ip	Bind to this IP. Use 0.0.0.0 to bind to all interfaces.
errorCode
lostTrans
masterKey
onRoomAddRemove	Fired when new room is added or old room is removed
onUserConnect	Fired when new used is connected.
onUserVerify	Fired when new user is about to join the server
port	Listen on this UDP port. Port + 1 will be used for RTCP.
roomCount
rtcp	Internal RTCP stack.
serverName	Name of server.
userAllow
userCount

Events

Event

Description