<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="jit.qt.broadcast" module="jit" category="Jitter Networking, Jitter QuickTime">
	<digest>
		Broadcast video using RTSP (Macintosh only)
	</digest>
	<description>
		Use the <o>jit.qt.broadcast</o> object as an RTSP server. It takes a 4 char matrix as input, compresses the data and streams it over a network (local or internet) using the RTSP streaming standard.
		<p />
		<b>WINDOWS USERS: This object is currently unsupported.</b> 
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Jitter
		</metadata>
		<metadata name="tag">
			Jitter Networking
		</metadata>
		<metadata name="tag">
			Jitter QuickTime
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="matrix">
			<digest>
				in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="matrix">
			<digest>
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="matrix">
			<digest>
				out
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="matrix">
			<digest>
				dumpout
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--MOP-->
	<mop matrixinputcount="1" matrixoutputcount="1">
		<matrixoutput name="out" planelink="1" typelink="1" dimlink="1" minplanecount="4" maxplanecount="4" mindimcount="1" maxdimcount="32">
			<types>
				char
			</types>
		</matrixoutput>
	</mop>
	<!--MESSAGES-->
	<methodlist>
		<method name="pause">
			<arglist />
			<digest>
				Pause a running broadcast server
			</digest>
			<description>
				Pauses a running broadcast server. No effect if the server is idle.
			</description>
		</method>
		<method name="start">
			<arglist />
			<digest>
				Start the broadcast server
			</digest>
			<description>
				Starts the broadcast server.
			</description>
		</method>
		<method name="stop">
			<arglist />
			<digest>
				Stop the broadcast server
			</digest>
			<description>
				Stops the broadcast server.
			</description>
		</method>
		<method name="write">
			<arglist>
				<arg name="filename" optional="1" />
			</arglist>
			<digest>
				Write a session description protocol file to disk
			</digest>
			<description>
				Writes an SDP (session description protocol) file to disk. This file describes the streaming parameters in a form suitable for distribution to clients. Every time a broadcast parameter is modified (<at>vcodec</at>, for instance), a new SDP file must be written, or clients will have trouble connecting to the broadcast stream.
				<br />
				In the absence of a <i>filename</i> argument, a Save dialog will be presented.
			</description>
		</method>
	</methodlist>
	<jittermethodlist>
		<jittermethod name="bang" />
		<jittermethod name="clear" />
		<jittermethod name="exportattrs" />
		<jittermethod name="exportsummary" />
		<jittermethod name="getattributes" />
		<jittermethod name="getstate" />
		<jittermethod name="jit_matrix" />
		<jittermethod name="importattrs" />
		<jittermethod name="outputmatrix" />
		<jittermethod name="summary" />
	</jittermethodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="acodec" get="1" set="1" type="symbol" size="1">
			<digest>
				Audio codec for streaming
			</digest>
			<description>
				The audio codec for streaming (default = qdesign2)
				<br />
				The available codec types are <m>none</m>, <m>raw</m>, <m>big16</m>, <m>little16</m>, <m>float32</m>, <m>float64</m>, <m>24bit</m>, <m>32bit</m>, <m>little32</m>, <m>mace3</m>, <m>mace6</m>, <m>cdxa4</m>, <m>cdxa2</m>, <m>ima</m>, <m>ulaw</m>, <m>alaw</m>, <m>adpcm</m>, <m>dviima</m>, <m>dvaudio</m>, <m>qdesign</m>, <m>qdesign2</m>, <m>qualcomm</m>, <m>mp3</m>, <m>vdva</m>, <m>mpeg4</m>.
			</description>
		</attribute>
		<attribute name="aenable" get="1" set="1" type="int" size="1">
			<digest>
				Audio enable flag
			</digest>
			<description>
				Audio enable flag (default = 0)
				<br />
				This flag is only active in <at>mode</at> 2 (Sequence Grabber source mode) and determines whether sound will be streamed, as well as image.
			</description>
		</attribute>
		<attribute name="aip" get="1" set="1" type="symbol" size="1">
			<digest>
				Audio IP address
			</digest>
			<description>
				Audio IP address (default = variable)
				<br />
				In multicast mode (the default. See <at>unicast</at>, below), this IP address is automatically assigned, and read-only, and refers to the special multicast address client computers access to reach your broadcast.
				<br />
				In unicast mode, this IP address should be set to the IP address of the single client computer.
			</description>
		</attribute>
		<attribute name="aport" get="1" set="1" type="int" size="1">
			<digest>
				Audio broadcast port number
			</digest>
			<description>
				Audio broadcast port number (default = 8556)
				<br />
				The network port to be used by the audio portion of the broadcast stream.
			</description>
		</attribute>
		<attribute name="bitrate" get="1" set="1" type="int" size="1">
			<digest>
				Audio bitrate
			</digest>
			<description>
				Audio bitrate (default = 16)
				<br />
				16 = 16-bit audio
				<br />
				8 = 8-bit audio
			</description>
		</attribute>
		<attribute name="channels" get="1" set="1" type="int" size="1">
			<digest>
				Audio channel selection
			</digest>
			<description>
				Audio channel selection (default = 2)
				<br />
				1 = mono audio
				<br />
				2 = stereo audio
			</description>
		</attribute>
		<attribute name="codec" get="1" set="1" type="symbol" size="1">
			<digest>
				Video codec for streaming
			</digest>
			<description>
				The video codec for streaming (default = h263)
				<br />
				The following list of codecs is deprecated (retained for reference). See <at>codeclist</at>, below, for the preferred method to list valid system codecs.
				<br />
				<i>The available codec types are <m>raw</m>, <m>cinepak</m>, <m>graphics</m>, <m>animation</m>, <m>video</m>, <m>componentvideo</m>, <m>jpeg</m>, <m>mjpega</m>, <m>mjpegb</m>, <m>sgi</m>, <m>planarrgb</m>, <m>macpaint</m>, <m>gif</m>, <m>photocd</m>, <m>qdgx</m>, <m>avrjpeg</m>, <m>opendmljpeg</m>, <m>bmp</m>, <m>winraw</m>, <m>vector</m>, <m>qd</m>, <m>h261</m>, <m>h263</m>, <m>dvntsc</m>, <m>dvpal</m>, <m>dvprontsc</m>, <m>dvpropal</m>, <m>flc</m>, <m>targa</m>, <m>png</m>, <m>tiff</m>, <m>componentvideosigned</m>, <m>componentvideounsigned</m>, <m>cmyk</m>, <m>microsoft</m>, <m>sorenson</m>, <m>indeo4</m>, <m>argb64</m>, <m>rgb48</m>, <m>alphagrey32</m>, <m>grey16</m>, <m>mpegyuv420</m>, <m>yuv420</m>, <m>sorensonyuv9</m> and <m>mpeg4</m>.</i> 
			</description>
		</attribute>
		<attribute name="codeclist" get="1" set="0" type="symbol" size="256">
			<digest>
				Report the available video codecs
			</digest>
			<description>
				The valid video codecs available on the system
				<br />
				Sending the message <m>getcodeclist</m> will cause a list of all valid codecs (that is, those with a functioning compressor component) to be reported from the dumpout. This list is guaranteed to contain only working codecs, and should be used in preference to the old, static codec list.
			</description>
		</attribute>
		<attribute name="datarate" get="1" set="1" type="int" size="1">
			<digest>
				Data rate in frames/second
			</digest>
			<description>
				Sets the data rate in frames/second.
			</description>
		</attribute>
		<attribute name="dstrect" get="1" set="1" type="int" size="4">
			<digest>
				The rectangular portion of the streaming image to be drawn to when an incoming matrix is received
			</digest>
			<description>
				The rectangular portion of the streaming image to be drawn to, when an incoming matrix is received. (default = 0 0 (image width) (image height))
				<br />
				The proportions of the rectangle are expressed in the form <i>left top right bottom</i>. All values are relative to the top left corner of the viewing area of the streamed image.
			</description>
		</attribute>
		<attribute name="interp" get="1" set="1" type="int" size="1">
			<digest>
				Interpolation flag
			</digest>
			<description>
				Interpolation flag (default = 0)
				<br />
			</description>
		</attribute>
		<attribute name="ip" get="1" set="1" type="symbol" size="1">
			<digest>
				Video IP address
			</digest>
			<description>
				Video IP address (default = variable)
				<br />
				In multicast mode (the default. See <at>unicast</at>, below), this IP address is automatically assigned, and read-only, and refers to the special multicast address client computers access to reach your broadcast.
				<br />
				In unicast mode, this IP address should be set to the IP address of the single client computer.
			</description>
		</attribute>
		<attribute name="kframe" get="1" set="1" type="int" size="1">
			<digest>
				Keyframe rate
			</digest>
			<description>
				Keyframe rate (default = 50)
				<br />
				If set, the <o>jit.qt.broadcast</o> object will attempt to configure the video compressor to use the specified keyframe rate. Keyframes (temporal compression) are not available to all codecs.
			</description>
		</attribute>
		<attribute name="mode" get="1" set="1" type="int" size="1">
			<digest>
				Streaming source mode
			</digest>
			<description>
				Streaming source mode (default = 0)
				<br />
				0 = matrix input
				<br />
				1 = Hinted Movie input (uses the <at>movie</at> attribute to choose a pre-hinted source movie)
				<br />
				2 = Sequence Grabber input (uses an attached camera as the streaming source)
				<br />
				Modes 1 and 2 permit audio streaming, as well.
			</description>
		</attribute>
		<attribute name="movie" get="1" set="1" type="symbol" size="1">
			<digest>
				Source movie for <at>mode</at> 1
			</digest>
			<description>
				Source movie for <at>mode</at> 1 (default = &quot;&quot;)
				<br />
				If no movie is specified when setting this attribute, a File dialog will be presented. Movies must be hinted, to be used with the <o>jit.qt.broadcast</o> object. See <i>Tutorial 51: Broadcasting</i> for more information.
			</description>
		</attribute>
		<attribute name="preview" get="1" set="1" type="int" size="1">
			<digest>
				Matrix preview flag
			</digest>
			<description>
				Matrix preview flag (default = 0)
				<br />
				If set, an incoming matrix will be copied to the object's output matrix (with <at>srcrect</at>, <at>interp</at> or <at>dstrect</at> transformations) when the <o>jit.qt.broadcast</o> object is streaming. Otherwise, the matrix is simply passed through the object. Only functional in <at>mode</at> 0.
			</description>
		</attribute>
		<attribute name="samplerate" get="1" set="1" type="float" size="1">
			<digest>
				Audio sample rate
			</digest>
			<description>
				Audio sample rate (default = 8000)
				<br />
				48000 = 48kHz
				<br />
				44100 = 44.1kHz
				<br />
				32000 = 32kHz
				<br />
				22050 = 22.050kHz
				<br />
				22254 = 22kHz
				<br />
				16000 = 16kHz
				<br />
				11127 = 11kHz
				<br />
				11025 = 11.025kHz
				<br />
				8000 = 8000 Hz
			</description>
		</attribute>
		<attribute name="size" get="1" set="1" type="int" size="2">
			<digest>
				Broadcast dimensions
			</digest>
			<description>
				The dimensions of the broadcast (default = 160 120)
				<br />
			</description>
		</attribute>
		<attribute name="spatialquality" get="1" set="1" type="symbol" size="1">
			<digest>
				Codec spatial compression quality
			</digest>
			<description>
				Codec spatial compression quality (default = 2 (normal))
				<br />
				0 or min = minimum
				<br />
				1 or low = low
				<br />
				2 or normal = normal
				<br />
				3 or high = high
				<br />
				4 or max = maximum
				<br />
				5 or lossless = lossless
				<br />
				<br />
				Note that minimum quality is, in many cases, the codec's default quality. Use &quot;low&quot; quality for consistent results.
			</description>
		</attribute>
		<attribute name="srcrect" get="1" set="1" type="int" size="4">
			<digest>
				Rectangular section of the incoming matrix to compress and stream
			</digest>
			<description>
				The rectangular section of the incoming matrix to compress and stream (default = 0 0 (movie width) (movie height))
			</description>
		</attribute>
		<attribute name="streamname" get="1" set="1" type="symbol" size="1">
			<digest>
				Broadcast stream name as displayed in the stream's URL
			</digest>
			<description>
				Name of the broadcast stream, as displayed in the stream's URL (default = &quot;Jitter&quot;)
				<br />
			</description>
		</attribute>
		<attribute name="temporalquality" get="1" set="1" type="symbol" size="1">
			<digest>
				Codec temporal compression quality
			</digest>
			<description>
				Codec temporal compression quality (default = 2 (normal))
				<br />
				0 or min = minimum
				<br />
				1 or low = low
				<br />
				2 or normal = normal
				<br />
				3 or high = high
				<br />
				4 or max = maximum
				<br />
				5 or lossless = lossless
				<br />
				<br />
				Note that minimum quality is, in many cases, the codec's default quality. Use &quot;low&quot; quality for consistent results.
			</description>
		</attribute>
		<attribute name="ttl" get="1" set="1" type="int" size="1">
			<digest>
				Packet time to live
			</digest>
			<description>
				Packet time to live (default = 255)
				<br />
			</description>
		</attribute>
		<attribute name="unicast" get="1" set="1" type="int" size="1">
			<digest>
				Unicast broadcast flag
			</digest>
			<description>
				Unicast broadcast flag (default = 0)
				<br />
				If set, the <o>jit.qt.broadcast</o> object will broadcast in unicast mode. In this mode, the <at>vip</at> (and <at>aip</at>, if used) refer to a single client computer, which will be able to receive your broadcast. In multicast mode (the default), as many clients as your system's bandwidth can support will be able to access the stream.
			</description>
		</attribute>
		<attribute name="usedstrect" get="1" set="1" type="int" size="1">
			<digest>
				Destination rect flag
			</digest>
			<description>
				Destination rect flag (default = 0)
				<br />
				When the flag is set, the <at>dstrect</at> attributes are used when compressing an input matrix for streaming.
			</description>
		</attribute>
		<attribute name="usesrcrect" get="1" set="1" type="int" size="1">
			<digest>
				Source rect flag
			</digest>
			<description>
				Source rect flag (default = 0)
				<br />
				When the flag is set, the <at>srcrect</at> attributes are used when compressing an input matrix for streaming. The proportions of the rectangle are expressed in the form <i>left top right bottom</i>. All values are relative to the top left corner of the viewing area of the incoming matrix.
			</description>
		</attribute>
		<attribute name="vcodec" get="1" set="1" type="symbol" size="1">
			<digest>
				Video codec for streaming
			</digest>
			<description>
				The video codec for streaming (default = h263)
				<br />
				Synonym for <at>codec</at>, above.
			</description>
		</attribute>
		<attribute name="venable" get="1" set="1" type="int" size="1">
			<digest>
				Video enable flag
			</digest>
			<description>
				Video enable flag (default = 1)
				<br />
				This flag is currently ignored.
			</description>
		</attribute>
		<attribute name="vip" get="1" set="1" type="symbol" size="1">
			<digest>
				Video IP address
			</digest>
			<description>
				Video IP address (default = variable)
				<br />
				Synonym for <at>ip</at>, above.
			</description>
		</attribute>
		<attribute name="vport" get="1" set="1" type="int" size="1">
			<digest>
				Video broadcast port number
			</digest>
			<description>
				Video broadcast port number (default = 8554)
				<br />
				The network port to be used by the video portion of the broadcast stream.
			</description>
		</attribute>
	</attributelist>
	<jitterattributelist>
		<jitterattribute name="outputmode" />
		<jitterattribute name="out_name" />
		<jitterattribute name="type" />
		<jitterattribute name="planecount" />
	</jitterattributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="jit.qt.broadcast.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="jit.net.recv" />
		<seealso name="jit.net.send" />
		<seealso name="jit.broadcast" />
		<seealso module="jit" name="jitterchapter53" type="tutorial" />
	</seealsolist>
</c74object>
