A B C D E F G H I L M N O P R S T V W

A

add(float[]) - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

addMessageListener(SoniTalkDecoder.MessageListener) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

addSpectrumListener(SoniTalkDecoder.SpectrumListener) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

applyWindow(double[]) - Method in class at.ac.fhstp.sonitalk.utils.HammingWindow

applyWindow(double[]) - Method in interface at.ac.fhstp.sonitalk.utils.WindowFunction

Apply the windowing function to the provided input data in-place.

at.ac.fhstp.sonitalk - package at.ac.fhstp.sonitalk

The package at.ac.fhstp.sonitalk is a library enabling developers to use the loudspeaker and microphone of a device to exchange data.

at.ac.fhstp.sonitalk.exceptions - package at.ac.fhstp.sonitalk.exceptions

The package at.ac.fhstp.sonitalk.exceptions is providing custom exceptions for the library.

at.ac.fhstp.sonitalk.utils - package at.ac.fhstp.sonitalk.utils

The package at.ac.fhstp.sonitalk.utils is providing functionality for processing messages and audio data.

B

binaryToBytes(String) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Takes a String containing a bit sequence and return the corresponding byte array

BIT_PERIOD - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

byteToUTF8(byte[]) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

C

cancel() - Method in class at.ac.fhstp.sonitalk.SoniTalkSender

Cancels the current send job if there was one running.

changeToBitString(byte[]) - Static method in class at.ac.fhstp.sonitalk.utils.EncoderUtils

Casts a byte array to bit and checks for characters with more than one byte.

checkMessageCRC(int[]) - Method in class at.ac.fhstp.sonitalk.utils.CRC

Checks if a message was received correctly.

CircularArray - Class in at.ac.fhstp.sonitalk.utils

Class handling a circular array of the incoming audio data to reduce memory allocation.

CircularArray(int) - Constructor for class at.ac.fhstp.sonitalk.utils.CircularArray

ConfigConstants - Class in at.ac.fhstp.sonitalk.utils

Set of constants used e.g.

ConfigConstants() - Constructor for class at.ac.fhstp.sonitalk.utils.ConfigConstants

ConfigException - Exception in at.ac.fhstp.sonitalk.exceptions

Exception thrown when trying to build a SoniTalkConfig object from a JSON file that does not respect the required format.

ConfigException() - Constructor for exception at.ac.fhstp.sonitalk.exceptions.ConfigException

Constructs a new exception with null as its detail message.

ConfigException(String) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.ConfigException

Constructs a new exception with the specified detail message.

ConfigException(String, Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.ConfigException

Constructs a new exception with the specified detail message and cause.

ConfigException(Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.ConfigException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

ConfigFactory - Class in at.ac.fhstp.sonitalk.utils

Utility class for building SoniTalkConfig objects from JSON files.

ConfigFactory() - Constructor for class at.ac.fhstp.sonitalk.utils.ConfigFactory

CONTROL_FILLING_CHARACTER - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

countOccurrences(String, char) - Static method in class at.ac.fhstp.sonitalk.utils.CRC

Returns the number of occurrences of searchedChar in input.

CRC - Class in at.ac.fhstp.sonitalk.utils

The CRC class adds and also checks the parity bits.

CRC() - Constructor for class at.ac.fhstp.sonitalk.utils.CRC

CRC(byte[]) - Constructor for class at.ac.fhstp.sonitalk.utils.CRC

D

decodeBitToText(String) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

DecoderStateException - Exception in at.ac.fhstp.sonitalk.exceptions

Exception thrown when trying to e.g.

DecoderStateException() - Constructor for exception at.ac.fhstp.sonitalk.exceptions.DecoderStateException

Constructs a new exception with null as its detail message.

DecoderStateException(String) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.DecoderStateException

Constructs a new exception with the specified detail message.

DecoderStateException(String, Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.DecoderStateException

Constructs a new exception with the specified detail message and cause.

DecoderStateException(Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.DecoderStateException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

DecoderUtils - Class in at.ac.fhstp.sonitalk.utils

Provides functions for removing filling characters and the crc-bits and for casting bytes back to utf-8 characters.

DEFAULT_PROFILE_FILENAME - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigFactory

E

EncoderUtils - Class in at.ac.fhstp.sonitalk.utils

The main part of EncoderUtils is to change the message bytes to bit.

EncoderUtils() - Constructor for class at.ac.fhstp.sonitalk.utils.EncoderUtils

F

freq2idx(int, int, int) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Get the index of a specific frequency depending on sample rate and window length

FREQUENCY_ZERO - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

fromString(String) - Static method in enum at.ac.fhstp.sonitalk.utils.SignalType

G

generateMessage(byte[]) - Method in class at.ac.fhstp.sonitalk.SoniTalkEncoder

Encodes a byte array of data using the configuration specified in the constructor.

GENERATOR_POLYNOM - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

getArray() - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

getBitperiod() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getComplexAbsolute(double, double) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Calculates an absolute value of a complex number

getConfigList(Context) - Static method in class at.ac.fhstp.sonitalk.utils.ConfigFactory

getDecoder(int, SoniTalkConfig) - Method in class at.ac.fhstp.sonitalk.SoniTalkContext

getDecodingTimeNanosecond() - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

getDefaultConfig(Context) - Static method in class at.ac.fhstp.sonitalk.utils.ConfigFactory

getEncoder(SoniTalkConfig) - Method in class at.ac.fhstp.sonitalk.SoniTalkContext

getEncoder(int, SoniTalkConfig) - Method in class at.ac.fhstp.sonitalk.SoniTalkContext

getFirstWindow(int) - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

getFrequencySpace() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getFrequencyZero() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getInstance(Context, SoniTalkPermissionsResultReceiver) - Static method in class at.ac.fhstp.sonitalk.SoniTalkContext

Instantiate a SoniTalkContext, allowing to create Encoder, Decoder and Sender objects.

getLastWindow(int) - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

getMessage() - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

getnFrequencies() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getnMessageBlocks() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getPauseperiod() - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

getRelativeIndexPosition(float, float, float) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

getSender() - Method in class at.ac.fhstp.sonitalk.SoniTalkContext

getSender(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkContext

getSignalBlock(SignalType, String[]) - Method in class at.ac.fhstp.sonitalk.utils.SignalGenerator

Starts generating an audio message block.

getStringOfEncodedBits(byte[], SoniTalkConfig) - Method in class at.ac.fhstp.sonitalk.utils.EncoderUtils

Uses byte array length check and returns the casted bit sequence or Exception.

H

HammingWindow - Class in at.ac.fhstp.sonitalk.utils

Hamming window class utility.

HammingWindow(int) - Constructor for class at.ac.fhstp.sonitalk.utils.HammingWindow

I

incrementAnalysisIndex(int) - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

isAllowedByteArraySize(byte[], SoniTalkConfig) - Static method in class at.ac.fhstp.sonitalk.utils.EncoderUtils

Checks if the byte array does not exceed the number of allowed bytes.

isCrcCorrect() - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

L

loadFromJson(String, Context) - Static method in class at.ac.fhstp.sonitalk.utils.ConfigFactory

M

max(double[]) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Helper to get maximum value out of double array

mean(double[]) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

the array double[] m MUST BE SORTED

median(double[]) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

the array double[] m MUST BE SORTED

N

newInstance(Bundle) - Static method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

newInstance(Bundle) - Static method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

nextPowerOfTwo(int) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Calculates power of two values

NUMBER_OF_FREQUENCIES - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

NUMBER_OF_MESSAGE_BLOCKS - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

O

ON_PERMISSION_LEVEL_DECLINED - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when the user chose to "Decline" when asked for the privacy level.

ON_REQUEST_DENIED - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the custom SoniTalk dialogs (L1/L2).

ON_REQUEST_GRANTED - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when a request is granted, i.e.

ON_REQUEST_L0_DENIED - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the Android permission system (L0).

ON_SEND_JOB_FINISHED - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when a "send job" is finished, i.e.

ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS - Static variable in class at.ac.fhstp.sonitalk.SoniTalkContext

Will be sent to the SoniTalkPermissionsResultReceiver when the user should show a rationale for the "Allow Always" (L0) SoniTalk permission.

onCancel(DialogInterface) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

onCancel(DialogInterface) - Method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

onCreate(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity

onCreate(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

onCreate(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity

onCreate(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

onCreateDialog(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

onCreateDialog(Bundle) - Method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

onDecoderError(String) - Method in interface at.ac.fhstp.sonitalk.SoniTalkDecoder.MessageListener

Called when an error and/or exception occur in the SoniTalkDecoder.

onDismiss(DialogInterface) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

onDismiss(DialogInterface) - Method in class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

onMessageReceived(SoniTalkMessage) - Method in interface at.ac.fhstp.sonitalk.SoniTalkDecoder.MessageListener

Called when a message is received by the SoniTalkDecoder.

onReceiveResult(int, Bundle) - Method in class at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver

onRequestPermissionsResult(int, String[], int[]) - Method in class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity

onSoniTalkPermissionResult(int, Bundle) - Method in interface at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver.Receiver

Receiver interface for classes that should listen for callbacks from SoniTalk.

onSpectrum(float[][], boolean) - Method in interface at.ac.fhstp.sonitalk.SoniTalkDecoder.SpectrumListener

Called when a message is received by the SoniTalkDecoder.

P

parityBit(String) - Method in class at.ac.fhstp.sonitalk.utils.CRC

Calls xorArray to get a remainder bit sequence depending on the generator polynomal.

pause() - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Pauses the current capturing/decoding process without cancelling the potential timers.

PAUSE_PERIOD - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

PermissionLevelDialogActivity - Class in at.ac.fhstp.sonitalk

Activity for the different permission levels.

PermissionLevelDialogActivity() - Constructor for class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity

PermissionLevelDialogActivity.PermissionLevelDialogFragment - Class in at.ac.fhstp.sonitalk

Contains the alert dialog for the permission levels.

PermissionLevelDialogFragment() - Constructor for class at.ac.fhstp.sonitalk.PermissionLevelDialogActivity.PermissionLevelDialogFragment

PermissionRequestDialogActivity - Class in at.ac.fhstp.sonitalk

Activity for the decision on one permission level.

PermissionRequestDialogActivity() - Constructor for class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity

PermissionRequestDialogActivity.PermissionRequestDialogFragment - Class in at.ac.fhstp.sonitalk

Contains the alert dialog for the permission levels.

PermissionRequestDialogFragment() - Constructor for class at.ac.fhstp.sonitalk.PermissionRequestDialogActivity.PermissionRequestDialogFragment

R

receiveBackground(long, int) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Captures audio and tries decoding for delayMilliseconds ms.

receiveBackground(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Captures audio and tries detecting/decoding messages.

receiverForSending(ResultReceiver) - Static method in class at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver

removeFillingCharsAndCRCChars(String, int) - Static method in class at.ac.fhstp.sonitalk.utils.DecoderUtils

Checks for filling characters and error correction bits and deletes them.

removeMessageListener(SoniTalkDecoder.MessageListener) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

removeSpectrumListener(SoniTalkDecoder.SpectrumListener) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

resume() - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Resumes audio capturing and detecting/decoding messages.

returnsRawAudio() - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Returns true if detected messages will be returned with the original audio.

S

send(SoniTalkMessage, int) - Method in class at.ac.fhstp.sonitalk.SoniTalkSender

Sends a SoniTalkMessage once.

send(SoniTalkMessage, int, long, TimeUnit, int) - Method in class at.ac.fhstp.sonitalk.SoniTalkSender

Sends a SoniTalkMessage nTimes at a fixed delay.

setBitperiod(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setCrcIsCorrect(boolean) - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

setDecodingTimeNanosecond(long) - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

setFrequencySpace(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setFrequencyZero(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setMessage(byte[]) - Method in class at.ac.fhstp.sonitalk.SoniTalkMessage

setnFrequencies(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setnMessageBlocks(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setPauseperiod(int) - Method in class at.ac.fhstp.sonitalk.SoniTalkConfig

setReceiver(SoniTalkPermissionsResultReceiver.Receiver) - Method in class at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver

setReturnRawAudio(boolean) - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Decides if detected messages will be returned with the original audio or not.

SignalGenerator - Class in at.ac.fhstp.sonitalk.utils

The SignalGenerator handles the creation of the audio message.

SignalGenerator(SoniTalkConfig) - Constructor for class at.ac.fhstp.sonitalk.utils.SignalGenerator

Default constructor using a 44100Hz sample rate (works on all devices)

SignalGenerator(int, SoniTalkConfig) - Constructor for class at.ac.fhstp.sonitalk.utils.SignalGenerator

SignalType - Enum in at.ac.fhstp.sonitalk.utils

Enum that consists of different types for creating signals.

size() - Method in class at.ac.fhstp.sonitalk.utils.CircularArray

SoniTalkConfig - Class in at.ac.fhstp.sonitalk

Configuration, or profile, used to transmit data.

SoniTalkConfig(int, int, int, int, int, int) - Constructor for class at.ac.fhstp.sonitalk.SoniTalkConfig

SoniTalkContext - Class in at.ac.fhstp.sonitalk

Allows to create objects of the Encoder, Decoder and Sender.

SoniTalkDecoder - Class in at.ac.fhstp.sonitalk

Handles the capture of audio, the detection of messages and their decoding.

SoniTalkDecoder.MessageListener - Interface in at.ac.fhstp.sonitalk

Interface defining the callbacks to implement in order to receive messages from a SoniTalk Decoder.

SoniTalkDecoder.SpectrumListener - Interface in at.ac.fhstp.sonitalk

Interface defining the callbacks to implement in order to receive the spectrum of received messages.

SoniTalkEncoder - Class in at.ac.fhstp.sonitalk

Encodes the forwarded byte array and uses a SignalGenerator to get the raw audio data.

SoniTalkException - Exception in at.ac.fhstp.sonitalk.exceptions

Parent class for all exceptions coming from the SoniTalk SDK.

SoniTalkException() - Constructor for exception at.ac.fhstp.sonitalk.exceptions.SoniTalkException

Constructs a new exception with null as its detail message.

SoniTalkException(String) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.SoniTalkException

Constructs a new exception with the specified detail message.

SoniTalkException(String, Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.SoniTalkException

Constructs a new exception with the specified detail message and cause.

SoniTalkException(Throwable) - Constructor for exception at.ac.fhstp.sonitalk.exceptions.SoniTalkException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

SoniTalkMessage - Class in at.ac.fhstp.sonitalk

Wrapper class for messages (received or to be sent).

SoniTalkPermissionsResultReceiver - Class in at.ac.fhstp.sonitalk

Receiver interface for classes that should listen for callbacks from SoniTalk.

SoniTalkPermissionsResultReceiver(Handler) - Constructor for class at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver

SoniTalkPermissionsResultReceiver.Receiver - Interface in at.ac.fhstp.sonitalk

Receiver interface for classes that should listen for callbacks from SoniTalk.

soniTalkPermissionsResultReceiverTag - Static variable in class at.ac.fhstp.sonitalk.SoniTalkPermissionsResultReceiver

SoniTalkSender - Class in at.ac.fhstp.sonitalk

Handles the sendjob and playing of the actual audiotrack.

SPACE_BETWEEN_FREQUENCIES - Static variable in class at.ac.fhstp.sonitalk.utils.ConfigConstants

stopReceiving() - Method in class at.ac.fhstp.sonitalk.SoniTalkDecoder

Stops the capturing and decoding process.

T

toString() - Method in enum at.ac.fhstp.sonitalk.utils.SignalType

V

valueOf(String) - Static method in enum at.ac.fhstp.sonitalk.utils.SignalType

Returns the enum constant of this type with the specified name.

values() - Static method in enum at.ac.fhstp.sonitalk.utils.SignalType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WindowFunction - Interface in at.ac.fhstp.sonitalk.utils

Generic windowing interface utility to process spectrum.

A B C D E F G H I L M N O P R S T V W