Group object
Describes the set of channels defined by this Mission.
Property | Type | Required | Description |
type | Number | Required | The channel type indicator. Use 1 for talk (audio) channels; use 2 for Mission Control (presence) channels. |
id | String | Required | A UUID4 (conforming to RFC4122, optionally surrounded by braces) that uniquely identifies this group from all other groups. Unless idOverride is true, the group ID must be regenerated any time there is a change to the group configuration. The generated value must be unique for any given configuration, and groups configured with the same values should generate the same ID using a common hashing algorithm. See the Mission / Group ID Generation section for details. |
idOverride | Boolean | Required | Allows the group creator to enable or disable automatic ID generation. idOverride: true means that it's up to the user to provide the UUID manually. |
description | String | Optional | A short, user-defined, human readable description of the channel. |
name | String | Required | The user-assigned name of the channel, typically displayed as a title in the user interface. Ideally 16 characters or less; longer names may be truncated. |
cryptoPassword | String | Optional | The cryptographic baseline key material used to generate the symmetric encryption key. A 32-byte binary value, represented in hexadecimal text. May be generated by hashing a user-generated password. When this attribute is not present, audio is transmitted in the clear. It is not acceptable to pass an empty string to indicate no encryption; either the attribute is present with a valid, 32-byte hex value, or it must be absent from the JSON document. |
rx | Address Object | Required | The receive multicast address and port associated with this channel. Talk bursts transmitted on this address and port will be received by this channel. Typically the transmit and receive addresses are the same, but are not required to be. See the Address Object section for details. |
tx | Address Object | Required | The transmit multicast address and port associated with this channel. Transmitted talk bursts will be received by channels whose rx property specifies this same address and port. Typically the transmit and receive addresses are the same but are not required to be. See the Address Object section for details. |
txAudio | Transmit Audio Object | Optional | The transmit audio configuration (codec, duplex, etc.) used when sending talk bursts. See the Transmit Audio Object section for details. This property is only valid on talk channels (Type 1). |
presence | Presence Object | Conditionally Required | Mission control configuration parameters. See the Presence Object section for details. Required for Mission Control (type 2) channels; ignored for audio (type 1) channels. |
rallypoints | Array (Rallypoint Object) | Optional | A list Rallypoints that this group should connect to. An empty array or undefined implies that the channel does not operate using a Rallypoint (multicast only). |