Ventuz.OSC

<?xml version="1.0"?> <doc> <assembly> <name>Ventuz.OSC</name> </assembly> <members> <member name="T:Ventuz.OSC.OscException"> <summary> This exception is thrown, if any errors occured regarding the OSC protocol </summary> </member> <member name="M:Ventuz.OSC.OscException.#ctor(System.String)"> <summary> Creates an OscException with a specified message </summary> <param name="message">message of the exception</param> </member> <member name="M:Ventuz.OSC.OscException.#ctor(System.String,System.Exception)"> <summary> Creates an OscException with a specified message </summary> <param name="message">message of the exception</param> <param name="innerException">inner exception caught by the OSC classes</param> </member> <member name="T:Ventuz.OSC.OscMessage"> <summary> OscMessage is the base class of OscElement and OscBundle. It represents the smallest to be send/received via the OSC protocol </summary> </member> <member name="M:Ventuz.OSC.OscMessage.ToStream(System.IO.Stream)"> <summary> Write the message to the stream. </summary> <param name="stream"></param> </member> <member name="M:Ventuz.OSC.OscMessage.FromStream(System.IO.Stream)"> <summary> Reads an OSC message from a given stream. </summary> <param name="stream">The stream to read the OSC message from</param> <returns>The read message can represent a bundle or an element</returns> </member> <member name="T:Ventuz.OSC.OscBundle"> <summary> An OscBundle holds one or more OscElements and bundles them to one message. Only OscBundle can be sent or received. Therefore the simplest Osc message is a OscBundle holding one OscElement </summary> <example> <code> class MyClass { UdpWriter udpWriter; public MyClass() { this.udpWriter = new UdpWriter( "228.1.1.1", 7000 ); } public void Send() { udpWriter.SendBundle( new OscBundle( 0, new OscElement( "/Target", 1 ) ) ); } } </code> </example> </member> <member name="F:Ventuz.OSC.OscBundle.Immediate"> <summary> represents the OSC time tag 'Immediate' and has the value 1 </summary> </member> <member name="M:Ventuz.OSC.OscBundle.AddElement(Ventuz.OSC.OscMessage)"> <summary> Adds one further OscElement to the OscBundle </summary> <param name="element">OscMessage to be added</param> </member> <member name="M:Ventuz.OSC.OscBundle.FromStream(Ventuz.OSC.OscMessage.OscBinaryReader,System.Boolean,System.Int64)"> <summary> Creates an OSCBundle by reading the stream encapsulated in the OscBinaryReader. NOTE: an OscBundle can contain other OscBundles!!! </summary> <param name="bin">OscBinaryReader which encapsulates the actual data stream</param> <param name="continueRead">indicates if the second part of the '#bundle' tag should be read</param> <param name="bytesToRead">number of bytes that the OscBundle consists of. if value is set to -1 the complete stream should be read. values > 0 indicate an nested OscBundle.</param> <returns></returns> </member> <member name="M:Ventuz.OSC.OscBundle.ToStream(System.IO.Stream)"> <summary> Writes the OscBundle to a stream according to the OSC protocol </summary> <param name="stream">stream to write this OscBundle to</param> </member> <member name="M:Ventuz.OSC.OscBundle.ToTimeStamp(System.DateTime)"> <summary> Convert a .Net DateTime object into an OSC-Timestamp (NTP-Timestamp) A DateTime value before 1st Jan 1900 return an OSC/NTP immediate (1UL) </summary> <param name="dateTime">DateTime object to convert</param> <returns>OSC-Timestamp</returns> </member> <member name="M:Ventuz.OSC.OscBundle.ToDateTime(System.UInt64)"> <summary> Convert an OSC-Timestamp (NTP-Timestamp) into a .Net DateTime object. A value of one or zero return DateTime.MinValue </summary> <param name="timeStamp">OSC-Timestamp to convert</param> <returns>DateTime</returns> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor"> <summary> Creates a new empty OscBundle. Use the AddElement method to add OscElements to this OscBundle. The TimeStamp will be set to 'immediate' (1) </summary> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.UInt64)"> <summary> Creates a new empty OscBundle with the specified TimeTag. The TimeTag can be changed later as well. Use the AddElement method to add OscElements to this OscBundle. </summary> <param name="timeTag">TimeTag for the new OscBundle</param> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.DateTime)"> <summary> Creates a new empty OscBundle with the specified TimeTag. The TimeTag can be changed later as well. Use the AddElement method to add OscElements to this OscBundle. </summary> <param name="timeTag">TimeTag for the new OscBundle</param> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.UInt64,Ventuz.OSC.OscMessage)"> <summary> Creates an OscBundle with the specified TimeTag and adds one OscElement to it. The TimeTag can be changed later as well. Use the AddElement method to add more OscElements. </summary> <param name="timeTag">TimeTag for the new OscBundle</param> <param name="element1">OscMessage to add</param> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.DateTime,Ventuz.OSC.OscMessage)"> <summary> Creates an OscBundle with the specified TimeTag and adds one OscElement to it. The TimeTag can be changed later as well. Use the AddElement method to add more OscElements. </summary> <param name="timeTag">TimeTag for the new OscBundle</param> <param name="element1">OscMessage to add</param> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.UInt64,Ventuz.OSC.OscMessage,Ventuz.OSC.OscMessage)"> <summary> Creates an OscBundle with the specified TimeTag and adds two OscElements to it. The TimeTag can be changed later as well. Use the AddElement method to add more OscElements. </summary> <param name="timeTag">TimeTag for the new OscBundle</param> <param name="element1">First OscMessage to add</param> <param name="element2">Second OscMessage to add</param> </member> <member name="M:Ventuz.OSC.OscBundle.#ctor(System.DateTime,Ventuz.OSC.OscMessage,Ventuz.OSC.OscMessage)"> <summary> Creates an OscBundle wi