Click or drag to resize
ChirpLogo

ChirpSDK Class

Main Chirp Class.

Allow to send and receive data with Chirp's technology.

Inheritance Hierarchy
SystemObject
  ChirpChirpSDK

Namespace:  Chirp
Assemblies:   ChirpSDK-x32 (in ChirpSDK-x32.dll) Version: 3.5.0.17678
  ChirpSDK-x64 (in ChirpSDK-x64.dll) Version: 3.5.0.17671
Syntax
public sealed class ChirpSDK : IDisposable

The ChirpSDK type exposes the following members.

Constructors
  NameDescription
Public methodChirpSDK
ChirpSDK constructor.
Top
Properties
  NameDescription
Public propertyChannelCount

Get the number of channels supported by the config used.

By default, most configs only support a single channel.To discuss support for multi - channel transmission, please get in touch at developers@chirp.io.

Public propertyInfo

Return a short description string of the config being used.

An example of the type of string can be : "Chirp SDK with "standard - 2018" config v1 [max 32 bytes in 4.52s]"

Public propertyListenToSelf

Get or set the SDK's self listening property.

This tells the SDK if it can try to decode the data it sends. Defaults to false. Set to true if you want your application to be able to hear its own chirps.

Public propertyMaxPayloadLength
Get the maximum payload length allowed by the current config set for the SDK.
Public propertyRandomSeed
Sets the internal seed used for the random generation of the payloads.
Public propertyState

Get the state of the SDK.

See SDKState for the possible states of the SDK.

Public propertyTransmissionChannel

Get or set the channel on which the data is sent / received.

Chirp listens for broadcasts on all channels simultaneously, but only transmits on a single channel at a time. Allowed values are between 0 and ChannelCount - 1.

Public propertyVersion
Get the version number of the SDK.
Public propertyVolume

Get or set the volume of the SDK, between 0 and 1.

This volume only influences the SDK's software output volume, and may be affected by the system's hardware audio volume.

Top
Methods
  NameDescription
Public methodDispose
ChirpSDK destructor.
Public methodDuration
Get the duration, in seconds, for a given payload length.
Public methodIsValid

Validate a payload.

If uncertain, the user can call this function to confirm this payload can be sent without issues.

Public methodRandomPayload
Generate a byte array of the specified length and randomising its content.
Public methodRandomPayloadOfRandomLength
Generate a byte array of random length and randomising its content.
Public methodSend
Send a payload.
Public methodStart

Start the SDK and the audio processing.

From this call, it is possible to send and receive data.

Public methodStateForChannel
Get the SDK state for the given channel.
Public methodStop

Stop the SDK and the audio processing.

Once this function is called, some internal structures will be reset and any data being sent won't be recoverable.

Top
Events
  NameDescription
Public eventOnReceived

On received event.

Hook a function to get called when the SDK has received some data.

See OnReceivedDelegate for a more precise description of the delegate.
Public eventOnReceiving

On receiving event.

Hook a function to get called when the SDK is receiving some data.

See OnReceivingDelegate for a more precise description of the delegate.
Public eventOnSending

On sending event.

Hook a function to get called when the SDK is sending some data.

See OnSendingDelegate for a more precise description of the delegate.
Public eventOnSent

On sent event.

Hook a function to get called when the SDK has sent some data.

See OnSentDelegate for a more precise description of the delegate.
Public eventOnStateChanged

On state changed event.

Hook a function to get updates on the audio states of the SDK.

See OnStateChangedDelegate for a more precise description of the delegate.
Public eventOnUnsupportedCaptureDevice

On unsupported audio capture device event.

Hook a function to get called when a unsupported capture device is used.

See OnUnsupportedDeviceDelegate for a more precise description of the delegate.
Public eventOnUnsupportedRendererDevice

On unsupported audio renderer device event.

Hook a function to get called when a unsupported renderer device is used.

See OnUnsupportedDeviceDelegate for a more precise description of the delegate.
Top
See Also