Uses of Class
org.openhab.core.audio.AudioFormat

Packages that use AudioFormat

Package	Description
org.openhab.core.audio
org.openhab.core.audio.transcode
org.openhab.core.audio.utils
org.openhab.core.voice.dialog.trigger.ks
org.openhab.core.voice.stt
org.openhab.core.voice.tts

Uses of AudioFormat in org.openhab.core.audio

Fields in org.openhab.core.audio declared as AudioFormat

Modifier and Type	Field	Description
static final AudioFormat	AudioFormat.AAC	Generic AAC format without any further constraints
static final AudioFormat	AudioFormat.FLAC	Generic FLAC format without any further constraints
static final AudioFormat	AudioFormat.MP3	Generic MP3 format without any further constraints
static final AudioFormat	AudioFormat.OGG	Generic OGG format without any further constraints
static final AudioFormat	AudioFormat.PCM_ALAW	Generic PCM A-law format (no container) without any further constraints
static final AudioFormat	AudioFormat.PCM_SIGNED	Generic PCM signed format (no container) without any further constraints
static final AudioFormat	AudioFormat.PCM_ULAW	Generic PCM μ-law format (no container) without any further constraints
static final AudioFormat	AudioFormat.PCM_UNSIGNED	Generic PCM unsigned format (no container) without any further constraints
static final AudioFormat	AudioFormat.WAV	Generic WAV format without any further constraints

Methods in org.openhab.core.audio that return AudioFormat

Modifier and Type	Method	Description
static @Nullable AudioFormat	AudioFormat.getBestMatch(Set<AudioFormat> inputs, Set<AudioFormat> outputs)	Determines the best match between a list of audio formats supported by a source and a sink.
abstract AudioFormat	AudioStream.getFormat()	Gets the supported audio format
AudioFormat	ByteArrayAudioStream.getFormat()
AudioFormat	FileAudioStream.getFormat()
AudioFormat	PipedAudioStream.getFormat()
AudioFormat	URLAudioStream.getFormat()
static @Nullable AudioFormat	AudioFormat.getPreferredFormat(Set<AudioFormat> audioFormats)	Gets the first concrete AudioFormat in the passed set or a preferred one based on 16bit, 16KHz, big endian default
@Nullable AudioFormat	UnsupportedAudioFormatException.getUnsupportedFormat()	Gets the unsupported format

Methods in org.openhab.core.audio that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
Set<AudioFormat>	AudioSink.getSupportedFormats()	Gets a set containing all supported audio formats
Set<AudioFormat>	AudioSource.getSupportedFormats()	Obtain the audio formats supported by this AudioSource

Methods in org.openhab.core.audio with parameters of type AudioFormat

Modifier and Type	Method	Description
AudioStream	AudioSource.getInputStream(AudioFormat format)	Gets an AudioStream for reading audio data in supported audio format
boolean	AudioFormat.isCompatible(@Nullable AudioFormat audioFormat)	Determines if the passed AudioFormat is compatible with this AudioFormat.
static PipedAudioStream.Group	PipedAudioStream.newGroup(AudioFormat format)	Creates a new piped stream group used to open new streams and write data to them.
static PipedAudioStream.Group	PipedAudioStream.newGroup(AudioFormat format, int pipeSize)	Creates a new piped stream group used to open new streams and write data to them.

Method parameters in org.openhab.core.audio with type arguments of type AudioFormat

Modifier and Type	Method	Description
static @Nullable AudioFormat	AudioFormat.getBestMatch(Set<AudioFormat> inputs, Set<AudioFormat> outputs)	Determines the best match between a list of audio formats supported by a source and a sink.
static @Nullable AudioFormat	AudioFormat.getPreferredFormat(Set<AudioFormat> audioFormats)	Gets the first concrete AudioFormat in the passed set or a preferred one based on 16bit, 16KHz, big endian default

Constructors in org.openhab.core.audio with parameters of type AudioFormat

Modifier	Constructor	Description
	ByteArrayAudioStream(byte[] bytes, AudioFormat format)
	FileAudioStream(File file, AudioFormat format)
	FileAudioStream(File file, AudioFormat format, boolean isTemporaryFile)
protected	Group(AudioFormat format, int pipeSize)
protected	PipedAudioStream(AudioFormat format, int pipeSize, PipedOutputStream outputStream)
	UnsupportedAudioFormatException(String message, @Nullable AudioFormat unsupportedFormat)	Constructs a new exception with the specified detail message and unsupported format.
	UnsupportedAudioFormatException(String message, @Nullable AudioFormat unsupportedFormat, @Nullable Throwable cause)	Constructs a new exception with the specified detail message, unsupported format, and cause.

Uses of AudioFormat in org.openhab.core.audio.transcode

Fields in org.openhab.core.audio.transcode with type parameters of type AudioFormat

Modifier and Type	Field	Description
static final Set<AudioFormat>	AudioTranscoder.SUPPORTED_SOURCE_FORMATS
static final Set<AudioFormat>	AudioTranscoder.SUPPORTED_TARGET_FORMATS

Methods in org.openhab.core.audio.transcode that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
static Set<AudioFormat>	AudioTranscoder.getSupportedSourceFormats()	Gets the set of general audio formats supported for decoding (reading as source stream).
static Set<AudioFormat>	AudioTranscoder.getSupportedTargetFormats()	Gets the set of general audio formats supported for encoding (writing as target stream).

Methods in org.openhab.core.audio.transcode with parameters of type AudioFormat

Modifier and Type	Method	Description
static boolean	AudioTranscoder.canTranscode(@Nullable AudioFormat sourceFormat, @Nullable AudioFormat targetFormat)	Checks whether this transcoder can transcode from the source format to the target format.
static boolean	AudioTranscoder.isSourceSupported(@Nullable AudioFormat format)	Checks if the given audio format can be decoded from a source stream.
static boolean	AudioTranscoder.isSupported(@Nullable AudioFormat format)	Checks if the given audio format is supported by this transcoder (either for decoding or encoding).
static boolean	AudioTranscoder.isTargetSupported(@Nullable AudioFormat format)	Checks if the given audio format can be encoded to a target stream.
static AudioStream	AudioTranscoder.transcode(AudioStream source, AudioFormat targetFormat)	Transcodes the given audio stream to the requested target format.
static AudioStream	AudioTranscoder.transcode(AudioStream source, AudioFormat targetFormat, boolean requireSizeable)	Transcodes the given audio stream to the requested target format.
static AudioStream	AudioTranscoder.transcode(AudioStream source, AudioFormat targetFormat, Set<Class<? extends AudioStream>> supportedStreams)	Transcodes the given audio stream to the requested target format, taking into account supported stream types.

Method parameters in org.openhab.core.audio.transcode with type arguments of type AudioFormat

Modifier and Type	Method	Description
static AudioStream	AudioTranscoder.transcodeToSupported(AudioStream source, Set<AudioFormat> candidateFormats)	Transcodes the audio stream to a format supported by candidateFormats (e.g. from an AudioSink).
static AudioStream	AudioTranscoder.transcodeToSupported(AudioStream source, Set<AudioFormat> candidateFormats, boolean requireSizeable)	Transcodes the audio stream to a format supported by candidateFormats (e.g. from an AudioSink).
static AudioStream	AudioTranscoder.transcodeToSupported(AudioStream source, Set<AudioFormat> candidateFormats, Set<Class<? extends AudioStream>> supportedStreams)	Transcodes the audio stream to a format and stream type supported by candidateFormats and supportedStreams (e.g.

Uses of AudioFormat in org.openhab.core.audio.utils

Methods in org.openhab.core.audio.utils that return AudioFormat

Modifier and Type	Method	Description
static AudioFormat	AudioWaveUtils.parseWavFormat(InputStream inputStream)

Methods in org.openhab.core.audio.utils that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
static Set<AudioFormat>	ToneSynthesizer.getSupportedFormats()

Methods in org.openhab.core.audio.utils with parameters of type AudioFormat

Modifier and Type	Method	Description
default @Nullable Long	AudioSinkUtils.transferAndAnalyzeLength(InputStream in, OutputStream out, AudioFormat audioFormat)	Transfers data from an input stream to an output stream and computes on the fly its duration
@Nullable Long	AudioSinkUtils.transferAndAnalyzeLength(InputStream in, OutputStream out, AudioFormat audioFormat, boolean flush)	Transfers data from an input stream to an output stream and computes on the fly its duration
@Nullable Long	AudioSinkUtilsImpl.transferAndAnalyzeLength(InputStream in, OutputStream out, AudioFormat audioFormat, boolean flush)

Constructors in org.openhab.core.audio.utils with parameters of type AudioFormat

Modifier	Constructor	Description
	ToneSynthesizer(AudioFormat audioFormat)

Uses of AudioFormat in org.openhab.core.voice.dialog.trigger.ks

Methods in org.openhab.core.voice.dialog.trigger.ks that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
Set<AudioFormat>	KSService.getSupportedFormats()	Get the audio formats supported by this KSService

Uses of AudioFormat in org.openhab.core.voice.stt

Methods in org.openhab.core.voice.stt that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
Set<AudioFormat>	STTService.getSupportedFormats()	Get the audio formats supported by this STTService.

Uses of AudioFormat in org.openhab.core.voice.tts

Methods in org.openhab.core.voice.tts that return types with arguments of type AudioFormat

Modifier and Type	Method	Description
Set<AudioFormat>	TTSService.getSupportedFormats()	Obtain the audio formats supported by this TTSService

Methods in org.openhab.core.voice.tts with parameters of type AudioFormat

Modifier and Type	Method	Description
AudioStream	TTSCache.get(CachedTTSService tts, String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.
String	AbstractCachedTTSService.getCacheKey(String text, Voice voice, AudioFormat requestedFormat)
String	CachedTTSService.getCacheKey(String text, Voice voice, AudioFormat requestedFormat)	Construct a uniquely identifying string for the request.
AudioStream	AbstractCachedTTSService.synthesize(String text, Voice voice, AudioFormat requestedFormat)
AudioStream	TTSService.synthesize(String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.
AudioStream	CachedTTSService.synthesizeForCache(String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.