<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html xmlns:jxb="http://java.sun.com/xml/ns/jaxb" xmlns:none="http://none"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>PlcmTurnAllocation.json</title><meta http-equiv="X-UA-Compatible" content="IE=7"><style type="text/css"><!--@import url("https://staged.poly.com/clariti2/apidocs/clariti-current/representations/book_conversion_apr2012.css");--></style><link rel="stylesheet" type="text/css" href="https://staged.poly.com/clariti2/apidocs/clariti-current/css/plcm-wadl-xsd.css"><!--
[if IE]>
<STYLE type="text/css">.altova-rotate-left-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=3)} .altova-rotate-right-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=1)} </STYLE>
<![endif]
--><!--[if !IE]><!--><style type="text/css">.altova-rotate-left-textbox{-webkit-transform: rotate(-90deg) translate(-100%, 0%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(-90deg) translate(-100%, 0%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(-90deg) translate(-100%, 0%); -ms-transform-origin: 0% 0%;}.altova-rotate-right-textbox{-webkit-transform: rotate(90deg) translate(0%, -100%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(90deg) translate(0%, -100%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(90deg) translate(0%, -100%); -ms-transform-origin: 0% 0%;}</style><!--<![endif]--><style type="text/css">@page { margin-left:0.60in; margin-right:0.60in; margin-top:0.79in; margin-bottom:0.79in } @media print { br.altova-page-break { page-break-before: always; } }</style></head><body><h1><span>PlcmTurnAllocation</span></h1><dl style="margin-left: 18.000pt;"><dt><span><a name="plcm-turn-allocation" href="plcm-turn-allocation.json.htm#PlcmTurnAllocation">PlcmTurnAllocation</a></span></dt></dl><hr><h4><a name="PlcmTurnAllocation"><span>PlcmTurnAllocation Fields</span></a></h4><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead style="background-color:#ccc; "><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Description</span></th><th style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Attributes</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>id</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Automatically generated ID for each TURN allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>user</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The username of the WebRTC client that requested the allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>realm</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-turn-allocation.json.htm#Realm">Realm</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The realm used to authenticate the allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>clientAddress</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmInetAddress">PlcmInetAddress</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The WebRTC clients public IP address
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>relayAddress</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmInetAddress">PlcmInetAddress</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The public IP address for TURN media relay, mapped on the firewall (the External IP Address of NAT)
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>serverAddress</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmInetAddress">PlcmInetAddress</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The public IP address of either the client that requested the allocation or the peer, depending on the direction of media relay.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>age</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of seconds that the allocation has been active
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>expires</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of seconds remaining until the allocation expires if it is not renewed by the client
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>receivePackets</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of packets received by this allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>receiveBytes</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of bytes received by this allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>receiveRate</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The receive rate for this allocation measured in bytes per second
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>sendPackets</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of packets sent by this allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>sendBytes</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The number of bytes sent by this allocation
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>sendRate</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The send rate for this allocation measured in bytes per second
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>totalRate</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>int</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The total data rate for this allocation measured in bytes per second
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr></tbody></table><br><hr><h3><span>Nested Types/Restrictions</span></h3><br><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Restrictions</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="Realm"><span>Realm</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Length of value must be >=</span><span>1</span><br><span>Length of value must be <=</span><span>20</span></td></tr></tbody></table></body></html>