io.github.privacystreams.audio

Class Audio

java.lang.Object

io.github.privacystreams.core.Item

io.github.privacystreams.audio.Audio

@PSItem
public class Audio
extends Item

An Audio item represents an audio, could be an audio record from microphone, an audio file from storage, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUDIO_DATA The abstraction of audio data.
static java.lang.String	TIMESTAMP The timestamp of when the Audio item was generated.

Fields inherited from class io.github.privacystreams.core.Item

EOS, TIME_CREATED

Method Summary

Modifier and Type	Method and Description
static PStreamProvider	getFromStorage() Provide all Audio items in local file system.
static PStreamProvider	record(long duration) Provide an Audio item.
static PStreamProvider	recordPeriodic(long durationPerRecord, long interval) Provide a live stream of Audio items.

Methods inherited from class io.github.privacystreams.core.Item

containsField, equals, excludeFields, getAsBoolean, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValueByField, includeFields, isEndOfStream, setFieldValue, toDebugString, toJson, toMap, toString

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP

@PSItemField(type=java.lang.Long.class)
public static final java.lang.String TIMESTAMP

The timestamp of when the Audio item was generated.

See Also:

Constant Field Values

AUDIO_DATA

@PSItemField(type=AudioData.class)
public static final java.lang.String AUDIO_DATA

The abstraction of audio data. The value is an `AudioData` instance.

See Also:

Constant Field Values

Method Detail

record

public static PStreamProvider record(long duration)

Provide an Audio item. The audio is recorded from microphone for a certain duration of time. This provider requires `android.permission.RECORD_AUDIO` permission.

Parameters:

duration - the time duration of audio.

Returns:

the provider.

recordPeriodic

public static PStreamProvider recordPeriodic(long durationPerRecord,
                                             long interval)

Provide a live stream of Audio items. The audios are recorded from microphone periodically every certain time interval, and each Audio item is a certain duration of time long. For example, `recordPeriodic(1000, 4000)` will record audio from 0s-1s, 5s-6s, 10s-11s, ... This provider requires `android.permission.RECORD_AUDIO` permission.

Parameters:

durationPerRecord - the time duration of each audio record, in milliseconds.

interval - the time interval between each two records, in milliseconds.

Returns:

the provider

getFromStorage

public static PStreamProvider getFromStorage()

Provide all Audio items in local file system. This provider requires `android.permission.READ_EXTERNAL_STORAGE` permission.

Returns:

the provider function.