Home Units Hierarchy Routines All identifiers

Class unaRTPStreamer

Description

Hierarchy

Fields

Methods

Properties

Unit

unaSocks_RTP

Declaration

type unaRTPStreamer = class(unaThread)

Description

Basic RTP receiver (UDP only)

Hierarchy

TObject
unaObject
unaThread
unaRTPStreamer

Overview

Methods

	`function grantStop(): bool; override;`
	`procedure AfterConstruction(); override;`
	`procedure BeforeDestruction(); override;`
	`procedure rentSockets(doRent: bool);`
	`procedure onBye(si: prtp_site_info; soft: bool); virtual;`
	`procedure onDataSent(rtcp: bool; data: pointer; len: uint); virtual;`
	`procedure onIdle(rtcpIdle: bool); virtual;`
	`procedure onPayload(addr: PSockAddrIn; hdr: prtp_hdr; data: pointer; len, packetSize: uint); virtual;`
	`procedure onRTCPPacket(ssrc: u_int32; addr: PSockAddrIn; hdr: prtcp_common_hdr; packetSize: uint); virtual;`
	`procedure onSsrcCNAME(ssrc: u_int32; cname: prtcp_sdes_item); virtual;`
	`procedure pingsock();`
	`procedure pushRTCPPacket(packet: pointer; len: uint); virtual;`
	`procedure startIn(); override;`

Properties

	`property active: bool read f_active;`
	`property cname8: aString read f_cname8;`
	`property isMulticast: bool read f_isMC;`
	`property isRAW: bool read f_isRAW write f_isRAW;`
	`property isUDP: bool read f_isUDP;`
	`property noRTCP: bool read f_noRTCP write f_noRTCP;`
	`property rtcp: unaRTCPstack read f_rtcp;`
	`property socketError: int read f_socketError;`
	`property socketNoReading: bool read f_socketNoReading;`
	`property socketObjRTP: unaSocket read f_socket;`
	`property ttl: int read f_ttl write f_ttl;`
	`property userName: wString read f_userName write f_userName;`
	`property _SSRC: u_int32 read f_ssrc;`

Description

Methods

	`function grantStop(): bool; override;`
"Pings" main listening socket so it will return from select().

	`procedure AfterConstruction(); override;`

	`procedure BeforeDestruction(); override;`

	`procedure rentSockets(doRent: bool);`
Disables or enables internal sockets from reading. Some clients (like STUN) may need to disable sockets for short time.

	`procedure onBye(si: prtp_site_info; soft: bool); virtual;`
Called from RTCP thread when BYE packet was received.

procedure onDataSent(rtcp: bool; data: pointer; len: uint); virtual;

Called each time new packet is sent to remote side

Parameters

rtcp: true if that was RTCP payload
data: data sent
len: size of data sent

	`procedure onIdle(rtcpIdle: bool); virtual;`
Called from context of idle thread.

procedure onPayload(addr: PSockAddrIn; hdr: prtp_hdr; data: pointer; len, packetSize: uint); virtual;

New RTP packed was received.

Parameters

addr: Remote address packet was received from.
hdr: RTP packet header.
data: Packet payload.
len: Payload size.
packetSize: Packet size including padding.

procedure onRTCPPacket(ssrc: u_int32; addr: PSockAddrIn; hdr: prtcp_common_hdr; packetSize: uint); virtual;

Called from RTCP thread when new RTCP packed was received.

Parameters

ssrc: Generator of packet
addr: Remote address packet was received from.
hdr: RTCP packet header.
packetSize: Packet size including padding.

	`procedure onSsrcCNAME(ssrc: u_int32; cname: prtcp_sdes_item); virtual;`
Called from RTCP thread when SDES packet was received.

	`procedure pingsock();`
Sends 1 byte to main listening socket so it will return from select() immediately.

	`procedure pushRTCPPacket(packet: pointer; len: uint); virtual;`
Streamer (like transmitter) could have own set of destinations, give it a chance to push RTCP data over

	`procedure startIn(); override;`
Thread just started.

Properties

	`property active: bool read f_active;`

	`property cname8: aString read f_cname8;`
UTF8 version of CNAME

	`property isMulticast: bool read f_isMC;`
True if multicast.

	`property isRAW: bool read f_isRAW write f_isRAW;`
True if receiver is RAW (no RTP/RTCP will be used).

	`property isUDP: bool read f_isUDP;`
True if receiver is RAW (no RTP/RTCP will be used).

	`property noRTCP: bool read f_noRTCP write f_noRTCP;`
True if no RTCP support is required.

	`property rtcp: unaRTCPstack read f_rtcp;`
RTCP stack. Could be nil.

	`property socketError: int read f_socketError;`

	`property socketNoReading: bool read f_socketNoReading;`
Use rentSockets() to enable/disable

	`property socketObjRTP: unaSocket read f_socket;`
Internal socket.

	`property ttl: int read f_ttl write f_ttl;`
TTL value

	`property userName: wString read f_userName write f_userName;`
Default is className

	`property _SSRC: u_int32 read f_ssrc;`
SSRC

Generated by PasDoc 0.12.1 on 2012-10-09