WebPresenterConnection class

TCP client for every block in the Blackmagic Streaming Ethernet Protocol.

The protocol calls these devices Streaming Encoders. This client is named for the package's Web Presenter support while remaining compatible with Streaming Encoder HD and 4K units.

Properties

hashCode int
The hash code for this object.
no setterinherited
isConnected bool
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
socket Socket
final
state Map<String, Map<String, String>>
final
updates Stream<WebPresenterBlock>
All state blocks, including the initial device dump and later changes.
no setter

Methods

audioSettings() Future<WebPresenterBlock>
close() Future<void>
configureAudio(Map<String, Object?> settings) Future<WebPresenterBlock>
configureNetworkInterface(int index, Map<String, Object?> settings) Future<WebPresenterBlock>
configureStream(Map<String, Object?> settings) Future<WebPresenterBlock>
configureUi(Map<String, Object?> settings) Future<WebPresenterBlock>
factoryReset() Future<WebPresenterBlock>
identity() Future<WebPresenterBlock>
network() Future<WebPresenterBlock>
networkInterface(int index) Future<WebPresenterBlock>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reboot() Future<WebPresenterBlock>
removeAllStreamXml() Future<WebPresenterBlock>
removeStreamXml(String filename) Future<WebPresenterBlock>
requestStatus(String blockName) Future<WebPresenterBlock>
Requests a complete status dump of a protocol block.
sendBlock(String name, [Map<String, Object?> values = const {}]) Future<WebPresenterBlock>
Sends a block request or update. Values use manual key names verbatim.
setLabel(String label) Future<WebPresenterBlock>
startStream() Future<WebPresenterBlock>
stopStream() Future<WebPresenterBlock>
streamSettings() Future<WebPresenterBlock>
streamState() Future<WebPresenterBlock>
streamXml() Future<WebPresenterBlock>
toString() String
A string representation of this object.
inherited
uiSettings() Future<WebPresenterBlock>
uploadStreamXml(String filename, String xml) Future<WebPresenterBlock>
Uploads one XML custom-platform file. Blank XML lines are removed because blank lines terminate Ethernet protocol blocks.
version() Future<WebPresenterBlock>

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

connect(String host, {int port = 9977, Duration? timeout}) Future<WebPresenterConnection>