IAMFWriter Interface

Provides access to members that control the sequential writing of AMF.

Members

Name Description
Method EndAMF3Array Finishes writing an array.
Method EndAMF3Object Finishes writing object.
Method EndAMF3ObjectTraits Call this method to finish writing object traits and switch to writing members.
Method GetCopy Clones IAMFWriter. Useful when you want to preserve traits and object, string and trait references.
Method StartAMF3Array Starts writing of array. Returns object reference index.
Method StartAMF3CustomObject Starst writing a custom object. Contents of this kind of objects are user-defined.
Method StartAMF3Object Starts writing an object, sends traits by reference. Returns object reference index.
Method StartAMF3ObjectWithTraits Start writing an object with traits. Returns trait reference index end object reference index.
Read-only property Stream Obtains underlying stream.
Method WriteAMF3_​UTF8 This method is required if you want to write member names in traits.
Method WriteAMF3_​UTF8Ref This method is required if you want to write member names in traits by reference.
Method WriteAMF3ArrayDenseMarker Switches from writing of associative portion of an array to dense portion.
Method WriteAMF3ArrayRef Writes an array by reference.
Method WriteAMF3Bool Writes boolean value.
Method WriteAMF3ByteArray Writes byte array. Returns object reference index. Note that this is not an AMF3 array but another type - AMF3 byte array.
Method WriteAMF3ByteArrayRef Writes byte array by reference. Note that this is not an AMF3 array but another type - AMF3 byte array.
Method WriteAMF3Date Writes date. Returns object reference index.
Method WriteAMF3DateRef Writes date by reference. Important: do not use this method if you send dates as JSON numbers, references will be incorrect.
Method WriteAMF3Double Writes double (64-bit) value.
Method WriteAMF3Int Writes integer (32-bit) value.
Method WriteAMF3Null Writes null value.
Method WriteAMF3ObjectRef Writes object by reference.
Method WriteAMF3String Writes string value. Returns string reference index.
Method WriteAMF3StringRef Writes string value by reference.
Method WriteAMF3Undefined Writes undefined value.
Method WriteAMF3Variant Writes value types (excluding array and object), may return string or object reference index. If reference is not applicable, value_​ref is set to -1.
Method WriteAMF3Xml Writes XML. Returns object reference index.
Method WriteAMF3XmlDoc Writes XML document. Returns object reference index.
Method WriteAMF3XmlDocRef Writes XML document by reference.
Method WriteAMF3XmlRef Writes XML by reference.
Method WriteTo Specifies output AMF stream.
Method WriteU16 Writes short integer. AMF0 format only. Don't use this method for AMF3 objects.
Method WriteU32 Writes an integer. AMF0 format only. Don't use this method for AMF3 objects.
Method WriteU8 Writes a byte. AMF0 format only. Don't use this method for AMF3 objects.
Method WriteUTF8 This method is used to write AMF0 strings. AMF0 format only. Don't use this method for AMF3 objects.

IAMFWriter.EndAMF3Array Method

Finishes writing an array.

Public Sub EndAMF3Array ( _
)
public void EndAMF3Array (
);

IAMFWriter.EndAMF3Object Method

Finishes writing object.

Public Sub EndAMF3Object ( _
)
public void EndAMF3Object (
);

IAMFWriter.EndAMF3ObjectTraits Method

Call this method to finish writing object traits and switch to writing members.

Public Sub EndAMF3ObjectTraits ( _
)
public void EndAMF3ObjectTraits (
);

IAMFWriter.GetCopy Method

Clones IAMFWriter. Useful when you want to preserve traits and object, string and trait references.

Public Sub GetCopy ( _
    ByRef ppOutWriter As IAMFWriter _
)
public void GetCopy (
    ref IAMFWriter ppOutWriter
);

IAMFWriter.StartAMF3Array Method

Starts writing of array. Returns object reference index.

Public Sub StartAMF3Array ( _
    ByVal denseCount As Integer, _
    ByRef obj_ref As Integer _
)
public void StartAMF3Array (
    int denseCount,
    ref int obj_ref
);

IAMFWriter.StartAMF3CustomObject Method

Starst writing a custom object. Contents of this kind of objects are user-defined.

Public Sub StartAMF3CustomObject ( _
    ByVal classname As String, _
    ByRef obj_ref As Integer _
)
public void StartAMF3CustomObject (
    string classname,
    ref int obj_ref
);

IAMFWriter.StartAMF3Object Method

Starts writing an object, sends traits by reference. Returns object reference index.

Public Sub StartAMF3Object ( _
    ByVal traits_ref As Integer, _
    ByRef obj_ref As Integer _
)
public void StartAMF3Object (
    int traits_ref,
    ref int obj_ref
);

IAMFWriter.StartAMF3ObjectWithTraits Method

Start writing an object with traits. Returns trait reference index end object reference index.

Public Sub StartAMF3ObjectWithTraits ( _
    ByVal classname As String, _
    ByVal MemberCount As Integer, _
    ByVal dynamic As Boolean, _
    ByRef traits_ref As Integer, _
    ByRef obj_ref As Integer _
)
public void StartAMF3ObjectWithTraits (
    string classname,
    int MemberCount,
    bool dynamic,
    ref int traits_ref,
    ref int obj_ref
);

IAMFWriter.Stream Property

Obtains underlying stream.

Public ReadOnly Property Stream As IStream
public IStream Stream {get;}

IAMFWriter.WriteAMF3ArrayDenseMarker Method

Switches from writing of associative portion of an array to dense portion.

Public Sub WriteAMF3ArrayDenseMarker ( _
)
public void WriteAMF3ArrayDenseMarker (
);

IAMFWriter.WriteAMF3ArrayRef Method

Writes an array by reference.

Public Sub WriteAMF3ArrayRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3ArrayRef (
    int obj_ref
);

IAMFWriter.WriteAMF3Bool Method

Writes boolean value.

Public Sub WriteAMF3Bool ( _
    ByVal Value As Boolean _
)
public void WriteAMF3Bool (
    bool Value
);

IAMFWriter.WriteAMF3ByteArray Method

Writes byte array. Returns object reference index. Note that this is not an AMF3 array but another type - AMF3 byte array.

Public Sub WriteAMF3ByteArray ( _
    ByRef ppArray As Byte[]&, _
    ByRef obj_ref As Integer _
)
public void WriteAMF3ByteArray (
    ref Byte[]& ppArray,
    ref int obj_ref
);

IAMFWriter.WriteAMF3ByteArrayRef Method

Writes byte array by reference. Note that this is not an AMF3 array but another type - AMF3 byte array.

Public Sub WriteAMF3ByteArrayRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3ByteArrayRef (
    int obj_ref
);

IAMFWriter.WriteAMF3Date Method

Writes date. Returns object reference index.

Public Sub WriteAMF3Date ( _
    ByVal Value As DateTime, _
    ByVal asJsonNumber As Boolean, _
    ByRef obj_ref As Integer _
)
public void WriteAMF3Date (
    DateTime Value,
    bool asJsonNumber,
    ref int obj_ref
);

IAMFWriter.WriteAMF3DateRef Method

Writes date by reference. Important: do not use this method if you send dates as JSON numbers, references will be incorrect.

Public Sub WriteAMF3DateRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3DateRef (
    int obj_ref
);

IAMFWriter.WriteAMF3Double Method

Writes double (64-bit) value.

Public Sub WriteAMF3Double ( _
    ByVal Value As Double _
)
public void WriteAMF3Double (
    double Value
);

IAMFWriter.WriteAMF3Int Method

Writes integer (32-bit) value.

Public Sub WriteAMF3Int ( _
    ByVal Value As Integer _
)
public void WriteAMF3Int (
    int Value
);

IAMFWriter.WriteAMF3Null Method

Writes null value.

Public Sub WriteAMF3Null ( _
)
public void WriteAMF3Null (
);

IAMFWriter.WriteAMF3ObjectRef Method

Writes object by reference.

Public Sub WriteAMF3ObjectRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3ObjectRef (
    int obj_ref
);

IAMFWriter.WriteAMF3String Method

Writes string value. Returns string reference index.

Public Sub WriteAMF3String ( _
    ByVal Value As String, _
    ByRef string_ref As Integer _
)
public void WriteAMF3String (
    string Value,
    ref int string_ref
);

IAMFWriter.WriteAMF3StringRef Method

Writes string value by reference.

Public Sub WriteAMF3StringRef ( _
    ByVal string_ref As Integer _
)
public void WriteAMF3StringRef (
    int string_ref
);

IAMFWriter.WriteAMF3Undefined Method

Writes undefined value.

Public Sub WriteAMF3Undefined ( _
)
public void WriteAMF3Undefined (
);

IAMFWriter.WriteAMF3Variant Method

Writes value types (excluding array and object), may return string or object reference index. If reference is not applicable, value_ref is set to -1.

Public Sub WriteAMF3Variant ( _
    ByVal Value As Object, _
    ByRef value_ref As Integer _
)
public void WriteAMF3Variant (
    object Value,
    ref int value_ref
);

IAMFWriter.WriteAMF3Xml Method

Writes XML. Returns object reference index.

Public Sub WriteAMF3Xml ( _
    ByVal Value As String, _
    ByRef obj_ref As Integer _
)
public void WriteAMF3Xml (
    string Value,
    ref int obj_ref
);

IAMFWriter.WriteAMF3XmlDoc Method

Writes XML document. Returns object reference index.

Public Sub WriteAMF3XmlDoc ( _
    ByVal Value As String, _
    ByRef obj_ref As Integer _
)
public void WriteAMF3XmlDoc (
    string Value,
    ref int obj_ref
);

IAMFWriter.WriteAMF3XmlDocRef Method

Writes XML document by reference.

Public Sub WriteAMF3XmlDocRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3XmlDocRef (
    int obj_ref
);

IAMFWriter.WriteAMF3XmlRef Method

Writes XML by reference.

Public Sub WriteAMF3XmlRef ( _
    ByVal obj_ref As Integer _
)
public void WriteAMF3XmlRef (
    int obj_ref
);

IAMFWriter.WriteTo Method

Specifies output AMF stream.

Public Sub WriteTo ( _
    ByVal outputStream As IStream _
)
public void WriteTo (
    IStream outputStream
);

IAMFWriter.WriteU16 Method

Writes short integer. AMF0 format only. Don't use this method for AMF3 objects.

Public Sub WriteU16 ( _
    ByVal b As Short _
)
public void WriteU16 (
    short b
);

IAMFWriter.WriteU32 Method

Writes an integer. AMF0 format only. Don't use this method for AMF3 objects.

Public Sub WriteU32 ( _
    ByVal b As Integer _
)
public void WriteU32 (
    int b
);

IAMFWriter.WriteU8 Method

Writes a byte. AMF0 format only. Don't use this method for AMF3 objects.

Public Sub WriteU8 ( _
    ByVal b As Byte _
)
public void WriteU8 (
    byte b
);

IAMFWriter.WriteUTF8 Method

This method is used to write AMF0 strings. AMF0 format only. Don't use this method for AMF3 objects.

Public Sub WriteUTF8 ( _
    ByVal Value As String _
)
public void WriteUTF8 (
    string Value
);

Classes that implement IAMFWriter

Classes Description
AMFWriter A sequential AMF Writer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.