Module amf

Description
Data Types
Function Index
Function Details

AMF encode/decode functions and AMF value constructors.

References

AMF0 specification: http://download.macromedia.com/pub/labs/amf/amf0_spec_121207.pdf
AMF3 specification: http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/amf/pdf/amf-file-format-spec.pdf

Description

AMF encode/decode functions and AMF value constructors

Data Types

amf_array()

amf_array() = #amf_array{values = [amf:amf_value()], members = [amf:amf_kv_pair()]}

amf_avmplus_object()

amf_avmplus_object() = #amf_avmplus_object{value = amf:amf_value()}

amf_boolean()

amf_boolean() = boolean()

amf_byte_array()

amf_byte_array() = #amf_byte_array{data = binary()}

amf_class_name()

amf_class_name() = undefined | amf_string()

    'undefined' indicates an anonymous class

amf_date()

amf_date() = #amf_date{timestamp = erlang:timestamp()}

amf_dictionary()

amf_dictionary() = #amf_dictionary{members = [amf:amf_dictionary_entry()], weak = amf:amf_boolean()}

amf_dictionary_entry()

amf_dictionary_entry() = {Key::amf_value(), Value::amf_value()}

amf_dictionary_option()

amf_dictionary_option() = {weak, boolean()}

amf_ecma_array()

amf_ecma_array() = #amf_array{values = [], members = [amf:amf_kv_pair()]}

amf_exception()

amf_exception() = #amf_exception{type = amf:amf_exception_type(), message = any()}

amf_exception_type()

amf_exception_type() = invalid | partial | unsupported

  invalid:     Input is something wrong.
  partial:     Input binary is too small to complete decoding.
  unsupported: Some unsupported feature is needed to proceed.

amf_kv_pair()

amf_kv_pair() = {Key::amf_string(), Value::amf_value()}

amf_null()

amf_null() = null

amf_number()

amf_number() = number()

amf_object()

amf_object() = #amf_object{class = amf:amf_class_name(), dynamic = amf:amf_boolean(), sealed_fields = [amf:amf_string()], members = [amf:amf_kv_pair()]}

amf_object_option()

amf_object_option() = {class, amf_class_name()} | {dynamic, boolean()} | {sealed_fields, [amf_string()]}

amf_strict_array()

amf_strict_array() = [amf_value()]

amf_string()

amf_string() = binary()

amf_undefined()

amf_undefined() = undefined

amf_value()

amf_vector()

amf_vector() = #amf_vector{type = amf:amf_vector_element_type(), variable = amf:amf_boolean(), elements = [amf:amf_value()]}

amf_vector_element_type()

amf_vector_element_type() = int | uint | double | (ClassName::amf_string())

amf_vector_option()

amf_vector_option() = {variable, boolean()}

amf_version()

amf_version() = amf0 | amf3

amf_xml()

amf_xml() = #amf_xml{data = amf:amf_string()}

amf_xml_document()

amf_xml_document() = #amf_xml_document{data = amf:amf_string()}

Function Index

array/1	Make associative array.
array/2	Make generic array.
avmplus_object/1	Make AvmPlus Object.
byte_array/1	Make ByteArray.
date/1	Make date.
datetime_to_date/1	Make date from datetime.
decode/2	Decode AMF0/AMF3 binary data.
dictionary/1	Make dictionary.
dictionary/2	Make dictionary.
encode/2	Encode AMF0/AMF3 value.
msec_to_date/1	Make date from timestamp in milliseconds.
object/1	Make anonymous object.
object/2	Make object.
typed_object/2	Make typed-object.
vector/2	Make variable vector.
vector/3	Make vector.
xml/1	Make XML.
xml_document/1	Make XML Document.