MediaStreamTrack.h [plain text]
#pragma once
#if ENABLE(MEDIA_STREAM)
#include "ActiveDOMObject.h"
#include "DoubleRange.h"
#include "EventTarget.h"
#include "GenericTaskQueue.h"
#include "JSDOMPromiseDeferred.h"
#include "LongRange.h"
#include "MediaProducer.h"
#include "MediaStreamTrackPrivate.h"
#include "MediaTrackConstraints.h"
namespace WebCore {
class AudioSourceProvider;
class Document;
struct MediaTrackConstraints;
class MediaStreamTrack :
public RefCounted<MediaStreamTrack>,
public ActiveDOMObject,
public EventTargetWithInlineData,
private MediaProducer,
private MediaStreamTrackPrivate::Observer {
public:
class Observer {
public:
virtual ~Observer() { }
virtual void trackDidEnd() = 0;
};
static Ref<MediaStreamTrack> create(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
virtual ~MediaStreamTrack();
virtual bool isCanvas() const { return false; }
const AtomicString& kind() const;
WEBCORE_EXPORT const String& id() const;
const String& label() const;
bool enabled() const;
void setEnabled(bool);
bool muted() const;
enum class State { Live, Ended };
State readyState() const;
bool ended() const;
Ref<MediaStreamTrack> clone();
enum class StopMode { Silently, PostEvent };
void stopTrack(StopMode = StopMode::Silently);
bool isCaptureTrack() const { return m_private->isCaptureTrack(); }
struct TrackSettings {
std::optional<int> width;
std::optional<int> height;
std::optional<double> aspectRatio;
std::optional<double> frameRate;
String facingMode;
std::optional<double> volume;
std::optional<int> sampleRate;
std::optional<int> sampleSize;
std::optional<bool> echoCancellation;
String deviceId;
String groupId;
};
TrackSettings getSettings(Document&) const;
struct TrackCapabilities {
std::optional<LongRange> width;
std::optional<LongRange> height;
std::optional<DoubleRange> aspectRatio;
std::optional<DoubleRange> frameRate;
std::optional<Vector<String>> facingMode;
std::optional<DoubleRange> volume;
std::optional<LongRange> sampleRate;
std::optional<LongRange> sampleSize;
std::optional<Vector<bool>> echoCancellation;
String deviceId;
String groupId;
};
TrackCapabilities getCapabilities() const;
const MediaTrackConstraints& getConstraints() const { return m_constraints; }
void applyConstraints(const std::optional<MediaTrackConstraints>&, DOMPromiseDeferred<void>&&);
RealtimeMediaSource& source() const { return m_private->source(); }
MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
AudioSourceProvider* audioSourceProvider();
void pageMutedStateDidChange() final;
MediaProducer::MediaStateFlags mediaState() const final;
void addObserver(Observer&);
void removeObserver(Observer&);
using RefCounted::ref;
using RefCounted::deref;
bool hasPendingActivity() const final;
protected:
MediaStreamTrack(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
private:
explicit MediaStreamTrack(MediaStreamTrack&);
void configureTrackRendering();
Document* document() const;
void stop() final;
const char* activeDOMObjectName() const final;
bool canSuspendForDocumentSuspension() const final;
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
void trackStarted(MediaStreamTrackPrivate&) final;
void trackEnded(MediaStreamTrackPrivate&) final;
void trackMutedChanged(MediaStreamTrackPrivate&) final;
void trackSettingsChanged(MediaStreamTrackPrivate&) final;
void trackEnabledChanged(MediaStreamTrackPrivate&) final;
WeakPtr<MediaStreamTrack> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
Vector<Observer*> m_observers;
Ref<MediaStreamTrackPrivate> m_private;
MediaTrackConstraints m_constraints;
std::optional<DOMPromiseDeferred<void>> m_promise;
WeakPtrFactory<MediaStreamTrack> m_weakPtrFactory;
GenericTaskQueue<ScriptExecutionContext> m_taskQueue;
bool m_ended { false };
};
typedef Vector<RefPtr<MediaStreamTrack>> MediaStreamTrackVector;
}
#endif // ENABLE(MEDIA_STREAM)