toxcore

---

Description:

Content:

Namespaces:

• ToxAV - Public audio/video API for Tox clients.

Classes:

• ToxAV - The ToxAV instance type. Each ToxAV instance can be bound to only one Tox instance, and Tox instance can have only one ToxAV instance. One must make sure to close ToxAV instance prior closing Tox instance otherwise undefined behaviour occurs. Upon closing of ToxAV instance, all active calls will be forcibly terminated without notifying peers.

Enums:

• CallControl
• ErrAnswer
• ErrBitRateSet
• ErrCall
• ErrCallControl
• ErrNew
• ErrSendFrame
• FriendCallState

Delegates:

• public delegate void AudioBitRateCallback (ToxAV av, uint32 friend_number, uint32 audio_bit_rate)
  The function type for the audio_bit_rate callback. The event is triggered when the network becomes too saturated for current bit rates at which point core suggests new bit rates.
• public delegate void AudioReceiveFrameCallback (ToxAV av, uint32 friend_number, int16[] pcm, size_t sample_count, uint8 channels, uint32 sampling_rate)
  The function type for the audio_receive_frame callback. The callback can be called multiple times per single iteration depending on the amount of queued frames in the buffer. The received format is the same as in send function.
• public delegate void CallCallback (ToxAV av, uint32 friend_number, bool audio_enabled, bool video_enabled)
  The function type for the call callback.
• public delegate void CallStateCallback (ToxAV av, uint32 friend_number, FriendCallState state)
  The function type for the call_state callback.
• public delegate void GroupchatAudioReceiveFrameCallback (Tox self, uint32 group_number, uint32 peer_number, int16[] pcm, uint samples, uint8 channels, uint32 sampling_rate)
• public delegate void VideoBitRateCallback (ToxAV av, uint32 friend_number, uint32 video_bit_rate)
  The function type for the video_bit_rate callback. The event is triggered when the network becomes too saturated for current bit rates at which point core suggests new bit rates.
• public delegate void VideoReceiveFrameCallback (ToxAV av, uint32 friend_number, uint16 width, uint16 height, uint8[] y, uint8[] u, uint8[] v, int32 ystride, int32 ustride, int32 vstride)
  The function type for the video_receive_frame callback.
• ToxCore - Tox is a peer to peer (serverless) instant messenger aimed at making security and privacy easy to obtain for regular users. It uses NaCl for its encryption and authentication.

Classes:

• Options - This class contains all the startup options for Tox.
• Tox - The Tox instance type. All the state associated with a connection is held within the instance. Multiple instances can exist and operate concurrently. The maximum number of Tox instances that can exist on a single network device is limited. Note that this is not just a per-process limit, since the limiting factor is the number of usable ports on a device.

Enums:

• ConferenceType - Conference types for the conference_invite event.
• Connection - Protocols that can be used to connect to the network or friends.
• ErrBootstrap
• ErrConferenceById
• ErrConferenceByUId
• ErrConferenceDelete
• ErrConferenceGetType - Returns the type of conference (ConferenceType) that conference_number is. Return value is unspecified on failure.
• ErrConferenceInvite
• ErrConferenceJoin
• ErrConferenceNew
• ErrConferencePeerQuery - Error codes for peer info queries.
• ErrConferenceSendMessage
• ErrConferenceSetMaxOffline
• ErrConferenceTitle
• ErrFileControl
• ErrFileGet
• ErrFileSeek
• ErrFileSend
• ErrFileSendChunk
• ErrFriendAdd
• ErrFriendByPublicKey
• ErrFriendCustomPacket
• ErrFriendDelete
• ErrFriendGetLastOnline
• ErrFriendGetPublicKey
• ErrFriendQuery - Common error codes for friend state query functions.
• ErrFriendSendMessage
• ErrGetPort
• ErrNew
• ErrOptionsNew
• ErrSetInfo - Common error codes for all functions that set a piece of user-visible client information.
• ErrSetTyping
• FileControl
• FileKind - A list of pre-defined file kinds. Toxcore itself does not behave differently for different file kinds. These are a hint to the client telling it what use the sender intended for the file. The `kind` parameter in the send function and recv callback are `uint32_t`, not TOX_FILE_KIND, because clients can invent their own file kind. Unknown file kinds should be treated as TOX_FILE_KIND_DATA.
• LogLevel - Severity level of log messages.
• MessageType - Represents message types for tox_friend_send_message and conference messages.
• ProxyType - Type of proxy used to connect to TCP relays.
• SaveDataType - Type of savedata to create the Tox instance from.
• UserStatus - Represents the possible statuses a client can have.

Constants:

• public const uint32 ADDRESS_SIZE
  The size of a Tox address in bytes. Tox addresses are in the format [Public Key (PUBLIC_KEY_SIZE bytes)][nospam (4 bytes)][checksum (2 bytes)].
• public const uint32 CONFERENCE_ID_SIZE
  The size of a Tox Conference unique id in bytes.
• public const uint32 CONFERENCE_UID_SIZE
  The size of a Tox Conference unique id in bytes.
• public const uint32 FILE_ID_LENGTH
  The number of bytes in a file id.
• public const uint32 HASH_LENGTH
  The number of bytes in a hash generated by Tox.hash.
• public const uint32 MAX_CUSTOM_PACKET_SIZE
  Maximum size of custom packets. TODO(iphydf): should be LENGTH?
• public const uint32 MAX_FILENAME_LENGTH
  Maximum file name length for file transfers.
• public const uint32 MAX_FRIEND_REQUEST_LENGTH
  Maximum length of a friend request message in bytes.
• public const uint32 MAX_HOSTNAME_LENGTH
  Maximum length of a hostname, e.g. proxy or bootstrap node names.
• public const uint32 MAX_MESSAGE_LENGTH
  Maximum length of a single message after which it should be split.
• public const uint32 MAX_NAME_LENGTH
  Maximum length of a nickname in bytes.
• public const uint32 MAX_STATUS_MESSAGE_LENGTH
  Maximum length of a status message in bytes.
• public const uint32 NOSPAM_SIZE
  The size of the nospam in bytes when written in a Tox address.
• public const uint32 PUBLIC_KEY_SIZE
  The size of a Tox Public Key in bytes.
• public const uint32 SECRET_KEY_SIZE
  The size of a Tox Secret Key in bytes.

Delegates:

• public delegate void LogCallback (Tox self, LogLevel level, string file, uint32 line, string func, string message)
  This event is triggered when the toxcore library logs an internal message. This is mostly useful for debugging. This callback can be called from any function, not just Tox.iterate. This means the user data lifetime must at least extend between registering and unregistering it or tox_kill.

Methods:

• public uint32 address_size ()
  The size of a Tox address in bytes. Tox addresses are in the format [Public Key (PUBLIC_KEY_SIZE bytes)][nospam (4 bytes)][checksum (2 bytes)].
• public uint32 conference_id_size ()
  The size of a Tox Conference unique id in bytes.
• public uint32 conference_uid_size ()
  The size of a Tox Conference unique id in bytes.
• public uint32 file_id_length ()
  The number of bytes in a file id.
• public uint32 hash_length ()
  The number of bytes in a hash generated by Tox.hash.
• public uint32 max_custom_packet_size ()
  Maximum size of custom packets. TODO(iphydf): should be LENGTH?
• public uint32 max_filename_length ()
  Maximum file name length for file transfers.
• public uint32 max_friend_request_length ()
  Maximum length of a friend request message in bytes.
• public uint32 max_hostname_length ()
  Maximum length of a hostname, e.g. proxy or bootstrap node names.
• public uint32 max_message_length ()
  Maximum length of a single message after which it should be split.
• public uint32 max_name_length ()
  Maximum length of a nickname in bytes.
• public uint32 max_status_message_length ()
  Maximum length of a status message in bytes.
• public uint32 nospam_size ()
  The size of the nospam in bytes when written in a Tox address.
• public uint32 public_key_size ()
  The size of a Tox Public Key in bytes.
• public uint32 secret_key_size ()
  The size of a Tox Secret Key in bytes.
• Version

Constants:

• public const uint32 MAJOR
  The major version number. Incremented when the API or ABI changes in an incompatible way.
• public const uint32 MINOR
  The minor version number. Incremented when functionality is added without breaking the API or ABI. Set to 0 when the major version number is incremented.
• public const uint32 PATCH
  The patch or revision number. Incremented when bugfixes are applied without changing any functionality or API or ABI.

Methods:

• public bool is_compatible (uint32 major, uint32 minor, uint32 patch)
  Return whether the compiled library version is compatible with the passed version numbers.
• public uint32 major ()
  The major version number. Incremented when the API or ABI changes in an incompatible way.
• public uint32 minor ()
  The minor version number. Incremented when functionality is added without breaking the API or ABI. Set to 0 when the major version number is incremented.
• public uint32 patch ()
  The patch or revision number. Incremented when bugfixes are applied without changing any functionality or API or ABI.
• ToxEncryptSave - This module is organized into two parts.

Classes:

• PassKey - This type represents a pass-key.

Enums:

• ErrDecryption
• ErrEncryption
• ErrGetSalt
• ErrKeyDerivation

Constants:

• public const uint32 PASS_ENCRYPTION_EXTRA_LENGTH
  The amount of additional data required to store any encrypted byte array. Encrypting an array of N bytes requires N + pass_encryption_extra_length bytes in the encrypted byte array.
• public const uint32 PASS_KEY_LENGTH
  The size of the key part of a pass-key.
• public const uint32 PASS_SALT_LENGTH
  The size of the salt part of a pass-key.

Methods:

• public uint8[]? get_salt (uint8[] ciphertext, out ErrGetSalt error)
  Retrieves the salt used to encrypt the given data.
• public bool is_data_encrypted (uint8[] data)
  Determines whether or not the given data is encrypted by this module.
• public uint8[]? pass_decrypt (uint8[] ciphertext, uint8[]? passphrase, out ErrDecryption error)
  Decrypts the given data with the given passphrase.
• public uint8[]? pass_encrypt (uint8[] plaintext, uint8[]? passphrase, out ErrEncryption error)
  Encrypts the given data with the given passphrase.
• public uint32 pass_encryption_extra_length ()
  The amount of additional data required to store any encrypted byte array. Encrypting an array of N bytes requires N + pass_encryption_extra_length bytes in the encrypted byte array.
• public uint32 pass_key_length ()
  The size of the key part of a pass-key.
• public uint32 pass_salt_length ()
  The size of the salt part of a pass-key.