Recording class

Constructors

Recording({String? bucket, String? error, String? id, String? object, String? room, int? started, String? status})
Returns a new Recording instance.

Properties

bucket ↔ String?
Bucket is the object store bucket the recording is written to. It is stated beside the key rather than folded into one URI so a client reads two facts instead of splitting a string.
getter/setter pair
error ↔ String?
Error is the media server's reason when a recording failed, and empty otherwise.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
id ↔ String?
ID is the media server's egress id — the handle a later read names.
getter/setter pair
object ↔ String?
Object is the key inside that bucket. Empty only while the media server has not named a file yet. It says WHERE the recording is, not how to fetch it. Reading one back is a separate decision this surface deliberately does not make: a link to a private conversation needs its own answer about who may follow it and for how long, and inventing a short one here would be worse than not having it.
getter/setter pair
room ↔ String?
Room is the room this recording is of.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
started ↔ int?
Started is when the recording began, as the media server reports it: its own started_at, verbatim and unconverted. LiveKit's egress service sets that field from UnixNano, and a conversion this side cannot check against the running server would be a number that looks right and is wrong by a factor of a billion. 0 means it has not started.
getter/setter pair
status ↔ String?
Status is the media server's own state name: EGRESS_STARTING, EGRESS_ACTIVE, EGRESS_ENDING, EGRESS_COMPLETE, EGRESS_FAILED, EGRESS_ABORTED or EGRESS_LIMIT_REACHED. It is passed through rather than folded into a vocabulary of ours, so the answer cannot mean something the media server did not say.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

fromJson(dynamic value) → Recording?
Returns a new Recording instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) → List<Recording>
mapFromJson(dynamic json) → Map<String, Recording>
mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<Recording>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.