Home Units Hierarchy Routines All identifiers

Class unavclIPBroadcastPipe

Fields

Unit

Declaration

type unavclIPBroadcastPipe = class(unavclInOutPipe)

Description

Implements basic broadcast pipe.

Hierarchy

tComponent
unavclInOutPipe
unavclIPBroadcastPipe

Overview

Methods

	`function applyFormat(data: pointer; len: uint; provider: unavclInOutPipe = nil; restoreActiveState: bool = false): bool; override;`
	`function doOpen(): bool; override;`
	`function doRead(data: pointer; len: uint): uint; override;`
	`function getAvailableDataLen(index: integer): uint; override;`
	`function getFormatExchangeData(out data: pointer): uint; override;`
	`function isActive(): bool; override;`
	`procedure AfterConstruction(); override;`
	`procedure BeforeDestruction(); override;`
	`procedure setBroadcastAddr(const addrH: TIPv4H = TIPv4H(INADDR_BROADCAST));`
	`procedure bindSocket(); virtual;`
	`procedure doClose(); override;`
	`procedure doSetPort(const value: string); virtual;`

Properties

	`property bindTo: string read f_bindToIP write f_bindToIP;`
	`property port: string read getPort write setPort;`
	`property waveFormatTag: unsigned index 0 read f_waveFormatTag write setwaveParam default WAVE_FORMAT_PCM;`
	`property waveNumBits: unsigned index 3 read f_waveNumBits write setwaveParam default 16;`
	`property waveNumChannels: unsigned index 2 read f_waveNumChannels write setwaveParam default 2;`
	`property waveSamplesPerSec: unsigned index 1 read f_waveSamplesPerSec write setwaveParam default 44100;`

Description

Methods

	`function applyFormat(data: pointer; len: uint; provider: unavclInOutPipe = nil; restoreActiveState: bool = false): bool; override;`
Applies format on a pipe.

	`function doOpen(): bool; override;`
Opens a pipe.

	`function doRead(data: pointer; len: uint): uint; override;`
Reads data from pipe.

	`function getAvailableDataLen(index: integer): uint; override;`
Returns 0.

	`function getFormatExchangeData(out data: pointer): uint; override;`
Returns format exchange packet.

	`function isActive(): bool; override;`
Returns active state of a pipe.

	`procedure AfterConstruction(); override;`
Creates a broadcast pipe.

	`procedure BeforeDestruction(); override;`
Destroys broadcast pipe.

	`procedure setBroadcastAddr(const addrH: TIPv4H = TIPv4H(INADDR_BROADCAST));`
Sets the specific broadcast address.

	`procedure bindSocket(); virtual;`
Binds socket on a port (client) or broadcast address (server).

	`procedure doClose(); override;`
Closes a broadcast pipe.

	`procedure doSetPort(const value: string); virtual;`
Sets the port for broadcast socket.

Properties

	`property bindTo: string read f_bindToIP write f_bindToIP;`
Specifies IP address the socket should bind to. Default '0.0.0.0' means socket should bind to first available interface.

	`property port: string read getPort write setPort;`
Specifies port number for broadcast socket.

	`property waveFormatTag: unsigned index 0 read f_waveFormatTag write setwaveParam default WAVE_FORMAT_PCM;`
Specifies format tag of pipe audio stream.

	`property waveNumBits: unsigned index 3 read f_waveNumBits write setwaveParam default 16;`
Specifies number of bits for pipe audio stream.

	`property waveNumChannels: unsigned index 2 read f_waveNumChannels write setwaveParam default 2;`
Specifies number of channels for pipe audio stream.

	`property waveSamplesPerSec: unsigned index 1 read f_waveSamplesPerSec write setwaveParam default 44100;`
Specifies samples per second for pipe audio stream.

(c) 2012 Lake of Soft

Generated by PasDoc 0.12.1 on 2012-10-09