at.ac.fhstp.sonitalk

Class SoniTalkContext

java.lang.Object

at.ac.fhstp.sonitalk.SoniTalkContext

public class SoniTalkContext
extends java.lang.Object

Allows to create objects of the Encoder, Decoder and Sender. It handles the creation, initialization, updated and cancelation of notifications. Beside that the SoniTalkContext contains the request codes for the permission levels, granting and denying permission requests and checking if a send job is finished.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ON_PERMISSION_LEVEL_DECLINED Will be sent to the SoniTalkPermissionsResultReceiver when the user chose to "Decline" when asked for the privacy level.
static int	ON_REQUEST_DENIED Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the custom SoniTalk dialogs (L1/L2).
static int	ON_REQUEST_GRANTED Will be sent to the SoniTalkPermissionsResultReceiver when a request is granted, i.e.
static int	ON_REQUEST_L0_DENIED Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the Android permission system (L0).
static int	ON_SEND_JOB_FINISHED Will be sent to the SoniTalkPermissionsResultReceiver when a "send job" is finished, i.e.
static int	ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS Will be sent to the SoniTalkPermissionsResultReceiver when the user should show a rationale for the "Allow Always" (L0) SoniTalk permission.

Method Summary

Modifier and Type	Method and Description
SoniTalkDecoder	getDecoder(int sampleRate, SoniTalkConfig config)
SoniTalkEncoder	getEncoder(int sampleRate, SoniTalkConfig config)
SoniTalkEncoder	getEncoder(SoniTalkConfig config)
static SoniTalkContext	getInstance(android.content.Context context, SoniTalkPermissionsResultReceiver sdkListener) Instantiate a SoniTalkContext, allowing to create Encoder, Decoder and Sender objects.
SoniTalkSender	getSender()
SoniTalkSender	getSender(int sampleRate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ON_PERMISSION_LEVEL_DECLINED

public static final int ON_PERMISSION_LEVEL_DECLINED

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

See Also:

Constant Field Values

ON_REQUEST_GRANTED

public static final int ON_REQUEST_GRANTED

Will be sent to the SoniTalkPermissionsResultReceiver when a request is granted, i.e. when the user gave permission to start receiving/sending (potentially sending several occurrences).

See Also:

Constant Field Values

ON_REQUEST_DENIED

public static final int ON_REQUEST_DENIED

Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the custom SoniTalk dialogs (L1/L2). At least this callback (and ON_REQUEST_L0_DENIED) or ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS should be used to show some rationale to the user.

See Also:

Constant Field Values

ON_SEND_JOB_FINISHED

public static final int ON_SEND_JOB_FINISHED

Will be sent to the SoniTalkPermissionsResultReceiver when a "send job" is finished, i.e. if a message was to be sent several times, after the last occurrence has been emitted.

See Also:

Constant Field Values

ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS

public static final int ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS

Will be sent to the SoniTalkPermissionsResultReceiver when the user should show a rationale for the "Allow Always" (L0) SoniTalk permission. At least this callback or ON_REQUEST_DENIED should be used to show some rationale to the user.

See Also:

Constant Field Values

ON_REQUEST_L0_DENIED

public static final int ON_REQUEST_L0_DENIED

Will be sent to the SoniTalkPermissionsResultReceiver when the user denied a permission request from the Android permission system (L0). At least this callback (and ON_REQUEST_DENIED) or ON_SHOULD_SHOW_RATIONALE_FOR_ALLOW_ALWAYS should be used to show some rationale to the user.

See Also:

Constant Field Values

Method Detail

getInstance

public static SoniTalkContext getInstance(android.content.Context context,
                                          SoniTalkPermissionsResultReceiver sdkListener)

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

Parameters:

context - is used to get an application context.

sdkListener - ResultReceiver which will receive callbacks from SoniTalk. Please set the handler according to which thread should execute the callbacks (often the UI Thread if it handles UI components). Please call setReceiver and pass an object that implements SoniTalkPermissionsResultReceiver.Receiver interface in order to receive the callbacks (it can be an Activity, but then do not forget to set it back to null in onStop or onPause to avoid leaking your Activity on configuration changes).

Returns:

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

getDecoder

public SoniTalkDecoder getDecoder(int sampleRate,
                                  SoniTalkConfig config)

Parameters:

sampleRate - is used to start the decoder with the correct sample rate

config - can be generated with the utility class ConfigFactory and holds configurations for the decoder

Returns:

a new SoniTalkDecoder

getEncoder

public SoniTalkEncoder getEncoder(SoniTalkConfig config)

Parameters:

config - can be generated with the utility class ConfigFactory and holds configurations for the encoder

Returns:

a new SoniTalkEncoder

getEncoder

public SoniTalkEncoder getEncoder(int sampleRate,
                                  SoniTalkConfig config)

Parameters:

sampleRate - is used to start the encoder with the correct sample rate

config - can be generated with the utility class ConfigFactory and holds configurations for the encoder

Returns:

a new SoniTalkEncoder

getSender

public SoniTalkSender getSender()

Returns:

a sender object to transmit the encoded message of the encoder

getSender

public SoniTalkSender getSender(int sampleRate)

Parameters:

sampleRate - is used to get a sender with the correct sample rate

Returns:

a new SoniTalkSender to transmit the encoded message of the encoder