Skip to main content
Version: Latest

StreamerNode

danger

Deprecated. Use the <Audio> element with MediaElementAudioSourceNode for streaming audio instead to achieve the same functionality.

caution

Mobile only. Requires an FFmpeg-enabled native build — see Runtime flags.

The StreamerNode is an AudioScheduledSourceNode which represents a node that can decode and play Http Live Streaming data. Similar to all of AudioScheduledSourceNodes, it can be started only once. If you want to play the same sound again you have to create a new one.

AudioNode properties​

Constructor​

constructor(context: BaseAudioContext, options: StreamerOptions)

StreamerOptions​

ParameterTypeDefault
streamPathstring-Value for streamPath

Or by using BaseAudioContext factory method:

BaseAudioContext.createStreamer().

Example​

import React, { useRef } from 'react';
import {
AudioContext,
StreamerNode,
} from 'react-native-audio-api';

function App() {
const audioContextRef = useRef<AudioContext | null>(null);
if (!audioContextRef.current) {
audioContextRef.current = new AudioContext();
}
const streamer = audioContextRef.current.createStreamer();
streamer.initialize('link/to/your/hls/source');
streamer.connect(audioContextRef.current.destination);
streamer.start(audioContextRef.current.currentTime);
}

Properties​

It inherits all properties from AudioScheduledSourceNode.

AudioNodeproperties
NameTypeDescription
streamPath
Read only
stringString value representing url to stream.

Methods​

It inherits all methods from AudioScheduledSourceNode.