TsgcTURNClient › Properties › TURNOptions

TURNOptions Property

TURN-specific options: Allocation lifetime, long-term credentials, AutoRefresh and data-channel behaviour.

Syntax

property TURNOptions: TsgcTURNClient_Options read FTURNOptions write SetTURNOptions;

Default Value

—

Remarks

Groups the options that are specific to the TURN protocol on top of the inherited STUNOptions:

• Allocation.Lifetime: requested lifetime for the relay reservation, in seconds (default 600). Used as the LIFETIME attribute of ALLOCATE and REFRESH.
• Authentication: TURN-specific credentials. By default long-term credentials are required; set Username and Password to the values the TURN server expects. When non-empty they override the inherited STUN authentication block.
• AutoRefresh: when enabled, the component automatically sends REFRESH, CreatePermission and ChannelBind requests before each object expires. Flags Allocations, Channels and Permissions control which categories are refreshed.
• Fingerprint and Software: add FINGERPRINT and SOFTWARE attributes to TURN messages, independently of the STUN-level flags.

Example

oTURN.TURNOptions.Allocation.Lifetime := 600;
oTURN.TURNOptions.Authentication.Username := 'user';
oTURN.TURNOptions.Authentication.Password := 'secret';
oTURN.TURNOptions.AutoRefresh.Allocations := True;
oTURN.TURNOptions.AutoRefresh.Permissions := True;
oTURN.TURNOptions.AutoRefresh.Channels := True;
oTURN.Allocate;

Back to Properties