Class Message

Namespace

Gst

Assembly

Gst-1.0.dll

public sealed class Message : BoxedRecord, GTypeProvider, InstanceFactory, IEquatable<Message>, IDisposable

Inheritance

object

Message

Implements

BoxedRecord

GTypeProvider

InstanceFactory

IEquatable<Message>

IDisposable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Message()

public Message()

Message(MessageOwnedHandle)

public Message(MessageOwnedHandle handle)

Parameters

handle MessageOwnedHandle

Properties

Handle

public MessageOwnedHandle Handle { get; }

Property Value

MessageOwnedHandle

Seqnum

public uint Seqnum { get; set; }

Property Value

uint

Timestamp

public ulong Timestamp { get; set; }

Property Value

ulong

Type

public MessageType Type { get; set; }

Property Value

MessageType

Methods

AddRedirectEntry(string, TagList?, Structure?)

[Version("1.10")]
public void AddRedirectEntry(string location, TagList? tagList, Structure? entryStruct)

Parameters

location string

tagList TagList

entryStruct Structure

Copy()

public Message Copy()

Returns

Message

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Equals(Message?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(Message? other)

Parameters

other Message

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetDetails()

[Version("1.26")]
public Structure? GetDetails()

Returns

Structure

GetGType()

public static Type GetGType()

Returns

Type

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetNumRedirectEntries()

[Version("1.10")]
public nuint GetNumRedirectEntries()

Returns

nuint

GetSeqnum()

public uint GetSeqnum()

Returns

uint

GetStreamStatusObject()

public Value? GetStreamStatusObject()

Returns

Value

GetStructure()

public Structure? GetStructure()

Returns

Structure

HasName(string)

public bool HasName(string name)

Parameters

name string

Returns

bool

NewApplication(Object?, Structure)

public static Message NewApplication(Object? src, Structure structure)

Parameters

src Object

structure Structure

Returns

Message

NewAsyncDone(Object?, ClockTime)

public static Message NewAsyncDone(Object? src, ClockTime runningTime)

Parameters

src Object

runningTime ClockTime

Returns

Message

NewAsyncStart(Object?)

public static Message NewAsyncStart(Object? src)

Parameters

src Object

Returns

Message

NewBuffering(Object?, int)

public static Message NewBuffering(Object? src, int percent)

Parameters

src Object

percent int

Returns

Message

NewClockLost(Object?, Clock)

public static Message NewClockLost(Object? src, Clock clock)

Parameters

src Object

clock Clock

Returns

Message

NewClockProvide(Object?, Clock, bool)

public static Message NewClockProvide(Object? src, Clock clock, bool ready)

Parameters

src Object

clock Clock

ready bool

Returns

Message

NewCustom(MessageType, Object?, Structure?)

public static Message NewCustom(MessageType type, Object? src, Structure? structure)

Parameters

type MessageType

src Object

structure Structure

Returns

Message

NewDeviceAdded(Object?, Device)

[Version("1.4")]
public static Message NewDeviceAdded(Object? src, Device device)

Parameters

src Object

device Device

Returns

Message

NewDeviceChanged(Object?, Device, Device)

[Version("1.16")]
public static Message NewDeviceChanged(Object? src, Device device, Device changedDevice)

Parameters

src Object

device Device

changedDevice Device

Returns

Message

NewDeviceRemoved(Object?, Device)

[Version("1.4")]
public static Message NewDeviceRemoved(Object? src, Device device)

Parameters

src Object

device Device

Returns

Message

NewDurationChanged(Object?)

public static Message NewDurationChanged(Object? src)

Parameters

src Object

Returns

Message

NewElement(Object?, Structure)

public static Message NewElement(Object? src, Structure structure)

Parameters

src Object

structure Structure

Returns

Message

NewEos(Object?)

public static Message NewEos(Object? src)

Parameters

src Object

Returns

Message

NewError(Object?, Error, string)

public static Message NewError(Object? src, Error error, string debug)

Parameters

src Object

error Error

debug string

Returns

Message

NewErrorWithDetails(Object?, Error, string, Structure?)

[Version("1.10")]
public static Message NewErrorWithDetails(Object? src, Error error, string debug, Structure? details)

Parameters

src Object

error Error

debug string

details Structure

Returns

Message

NewHaveContext(Object?, Context)

[Version("1.2")]
public static Message NewHaveContext(Object? src, Context context)

Parameters

src Object

context Context

Returns

Message

NewInfo(Object?, Error, string)

public static Message NewInfo(Object? src, Error error, string debug)

Parameters

src Object

error Error

debug string

Returns

Message

NewInfoWithDetails(Object?, Error, string, Structure?)

[Version("1.10")]
public static Message NewInfoWithDetails(Object? src, Error error, string debug, Structure? details)

Parameters

src Object

error Error

debug string

details Structure

Returns

Message

NewInstantRateRequest(Object?, double)

[Version("1.18")]
public static Message NewInstantRateRequest(Object? src, double rateMultiplier)

Parameters

src Object

rateMultiplier double

Returns

Message

NewLatency(Object?)

public static Message NewLatency(Object? src)

Parameters

src Object

Returns

Message

NewNeedContext(Object?, string)

[Version("1.2")]
public static Message NewNeedContext(Object? src, string contextType)

Parameters

src Object

contextType string

Returns

Message

NewNewClock(Object?, Clock)

public static Message NewNewClock(Object? src, Clock clock)

Parameters

src Object

clock Clock

Returns

Message

NewProgress(Object?, ProgressType, string, string)

public static Message NewProgress(Object? src, ProgressType type, string code, string text)

Parameters

src Object

type ProgressType

code string

text string

Returns

Message

NewPropertyNotify(Object, string, Value?)

[Version("1.10")]
public static Message NewPropertyNotify(Object src, string propertyName, Value? val)

Parameters

src Object

propertyName string

val Value

Returns

Message

NewQos(Object?, bool, ulong, ulong, ulong, ulong)

public static Message NewQos(Object? src, bool live, ulong runningTime, ulong streamTime, ulong timestamp, ulong duration)

Parameters

src Object

live bool

runningTime ulong

streamTime ulong

timestamp ulong

duration ulong

Returns

Message

NewRedirect(Object?, string, TagList?, Structure?)

[Version("1.10")]
public static Message NewRedirect(Object? src, string location, TagList? tagList, Structure? entryStruct)

Parameters

src Object

location string

tagList TagList

entryStruct Structure

Returns

Message

NewRequestState(Object?, State)

public static Message NewRequestState(Object? src, State state)

Parameters

src Object

state State

Returns

Message

NewResetTime(Object?, ClockTime)

public static Message NewResetTime(Object? src, ClockTime runningTime)

Parameters

src Object

runningTime ClockTime

Returns

Message

NewSegmentDone(Object?, Format, long)

public static Message NewSegmentDone(Object? src, Format format, long position)

Parameters

src Object

format Format

position long

Returns

Message

NewSegmentStart(Object?, Format, long)

public static Message NewSegmentStart(Object? src, Format format, long position)

Parameters

src Object

format Format

position long

Returns

Message

NewStateChanged(Object?, State, State, State)

public static Message NewStateChanged(Object? src, State oldstate, State newstate, State pending)

Parameters

src Object

oldstate State

newstate State

pending State

Returns

Message

NewStateDirty(Object?)

public static Message NewStateDirty(Object? src)

Parameters

src Object

Returns

Message

NewStepDone(Object?, Format, ulong, double, bool, bool, ulong, bool)

public static Message NewStepDone(Object? src, Format format, ulong amount, double rate, bool flush, bool intermediate, ulong duration, bool eos)

Parameters

src Object

format Format

amount ulong

rate double

flush bool

intermediate bool

duration ulong

eos bool

Returns

Message

NewStepStart(Object?, bool, Format, ulong, double, bool, bool)

public static Message NewStepStart(Object? src, bool active, Format format, ulong amount, double rate, bool flush, bool intermediate)

Parameters

src Object

active bool

format Format

amount ulong

rate double

flush bool

intermediate bool

Returns

Message

NewStreamCollection(Object?, StreamCollection)

[Version("1.10")]
public static Message NewStreamCollection(Object? src, StreamCollection collection)

Parameters

src Object

collection StreamCollection

Returns

Message

NewStreamStart(Object?)

public static Message NewStreamStart(Object? src)

Parameters

src Object

Returns

Message

NewStreamStatus(Object?, StreamStatusType, Element)

public static Message NewStreamStatus(Object? src, StreamStatusType type, Element owner)

Parameters

src Object

type StreamStatusType

owner Element

Returns

Message

NewStreamsSelected(Object?, StreamCollection)

[Version("1.10")]
public static Message NewStreamsSelected(Object? src, StreamCollection collection)

Parameters

src Object

collection StreamCollection

Returns

Message

NewStructureChange(Object?, StructureChangeType, Element, bool)

public static Message NewStructureChange(Object? src, StructureChangeType type, Element owner, bool busy)

Parameters

src Object

type StructureChangeType

owner Element

busy bool

Returns

Message

NewTag(Object?, TagList)

public static Message NewTag(Object? src, TagList tagList)

Parameters

src Object

tagList TagList

Returns

Message

NewToc(Object?, Toc, bool)

public static Message NewToc(Object? src, Toc toc, bool updated)

Parameters

src Object

toc Toc

updated bool

Returns

Message

NewWarning(Object?, Error, string)

public static Message NewWarning(Object? src, Error error, string debug)

Parameters

src Object

error Error

debug string

Returns

Message

NewWarningWithDetails(Object?, Error, string, Structure?)

[Version("1.10")]
public static Message NewWarningWithDetails(Object? src, Error error, string debug, Structure? details)

Parameters

src Object

error Error

debug string

details Structure

Returns

Message

ParseAsyncDone(out ClockTime)

public void ParseAsyncDone(out ClockTime runningTime)

Parameters

runningTime ClockTime

ParseBuffering(out int)

public void ParseBuffering(out int percent)

Parameters

percent int

ParseBufferingStats(out BufferingMode, out int, out int, out long)

public void ParseBufferingStats(out BufferingMode mode, out int avgIn, out int avgOut, out long bufferingLeft)

Parameters

mode BufferingMode

avgIn int

avgOut int

bufferingLeft long

ParseContextType(out string)

[Version("1.2")]
public bool ParseContextType(out string contextType)

Parameters

contextType string

Returns

bool

ParseGroupId(out uint)

[Version("1.2")]
public bool ParseGroupId(out uint groupId)

Parameters

groupId uint

Returns

bool

ParseHaveContext(out Context)

[Version("1.2")]
public void ParseHaveContext(out Context context)

Parameters

context Context

ParseInstantRateRequest(out double)

[Version("1.18")]
public void ParseInstantRateRequest(out double rateMultiplier)

Parameters

rateMultiplier double

ParseProgress(out ProgressType, out string, out string)

public void ParseProgress(out ProgressType type, out string code, out string text)

Parameters

type ProgressType

code string

text string

ParseQos(out bool, out ulong, out ulong, out ulong, out ulong)

public void ParseQos(out bool live, out ulong runningTime, out ulong streamTime, out ulong timestamp, out ulong duration)

Parameters

live bool

runningTime ulong

streamTime ulong

timestamp ulong

duration ulong

ParseQosStats(out Format, out ulong, out ulong)

public void ParseQosStats(out Format format, out ulong processed, out ulong dropped)

Parameters

format Format

processed ulong

dropped ulong

ParseQosValues(out long, out double, out int)

public void ParseQosValues(out long jitter, out double proportion, out int quality)

Parameters

jitter long

proportion double

quality int

ParseRequestState(out State)

public void ParseRequestState(out State state)

Parameters

state State

ParseResetTime(out ClockTime)

public void ParseResetTime(out ClockTime runningTime)

Parameters

runningTime ClockTime

ParseSegmentDone(out Format, out long)

public void ParseSegmentDone(out Format format, out long position)

Parameters

format Format

position long

ParseSegmentStart(out Format, out long)

public void ParseSegmentStart(out Format format, out long position)

Parameters

format Format

position long

ParseStateChanged(out State, out State, out State)

public void ParseStateChanged(out State oldstate, out State newstate, out State pending)

Parameters

oldstate State

newstate State

pending State

ParseStepDone(out Format, out ulong, out double, out bool, out bool, out ulong, out bool)

public void ParseStepDone(out Format format, out ulong amount, out double rate, out bool flush, out bool intermediate, out ulong duration, out bool eos)

Parameters

format Format

amount ulong

rate double

flush bool

intermediate bool

duration ulong

eos bool

ParseStepStart(out bool, out Format, out ulong, out double, out bool, out bool)

public void ParseStepStart(out bool active, out Format format, out ulong amount, out double rate, out bool flush, out bool intermediate)

Parameters

active bool

format Format

amount ulong

rate double

flush bool

intermediate bool

ParseToc(out Toc, out bool)

public void ParseToc(out Toc toc, out bool updated)

Parameters

toc Toc

updated bool

Ref()

public Message Ref()

Returns

Message

SetBufferingStats(BufferingMode, int, int, long)

public void SetBufferingStats(BufferingMode mode, int avgIn, int avgOut, long bufferingLeft)

Parameters

mode BufferingMode

avgIn int

avgOut int

bufferingLeft long

SetDetails(Structure?)

[Version("1.26")]
public void SetDetails(Structure? details)

Parameters

details Structure

SetGroupId(uint)

[Version("1.2")]
public void SetGroupId(uint groupId)

Parameters

groupId uint

SetQosStats(Format, ulong, ulong)

public void SetQosStats(Format format, ulong processed, ulong dropped)

Parameters

format Format

processed ulong

dropped ulong

SetQosValues(long, double, int)

public void SetQosValues(long jitter, double proportion, int quality)

Parameters

jitter long

proportion double

quality int

SetSeqnum(uint)

public void SetSeqnum(uint seqnum)

Parameters

seqnum uint

SetStreamStatusObject(Value)

public void SetStreamStatusObject(Value @object)

Parameters

object Value

StreamsSelectedAdd(Stream)

[Version("1.10")]
public void StreamsSelectedAdd(Stream stream)

Parameters

stream Stream

StreamsSelectedGetSize()

[Version("1.10")]
public uint StreamsSelectedGetSize()

Returns

uint

StreamsSelectedGetStream(uint)

[Version("1.10")]
public Stream? StreamsSelectedGetStream(uint idx)

Parameters

idx uint

Returns

Stream

Unref()

public void Unref()

WritableDetails()

[Version("1.26")]
public Structure WritableDetails()

Returns

Structure

WritableStructure()

[Version("1.14")]
public Structure WritableStructure()

Returns

Structure