A newer version of Max is available. Click here to access the latest version of the Max documentation

jit.qt.broadcast

Broadcast video using RTSP (Macintosh only)

Description

Use the jit.qt.broadcast 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.

WINDOWS USERS: This object is currently unsupported.

Examples

Matrix Operator

matrix inputs:1, matrix outputs:1
Name IOProc Planelink Typelink Dimlink Plane Dim Type
out n/a 1 1 1 4 1 char

More about Matrix Operators

The Jitter MOP

Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".

Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".

Matrix operators accept what we'll refer to as "matrix args"--i.e. [planecount (int)] [ type (symbol)] [dim (int list)]. if these arguments are present, the adapt attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the dim, planecount, and type attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".

The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.

MOP Arguments

planecount [int]

Optional

Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

type [symbol]

Optional

Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

dimensions [list]

Optional

Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

MOP Attributes

adapt [int]

Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.

[in/out]_dim [32 ints]

The matrix data dimensions (default = 1 1)

[in/out]_name [symbol]

The input or output name of the matrix (default = UID)

[in/out]_planecount [int]

The number of planes in matrix input our output data. Except in special cases, this value is equal to the planecount.

[in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type.

[in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type.

outputmode [int]

Output mode (default = 1 (calculate and output matrix))
0 = No output
1 = Calculate and output the matrix
2 = Pass input (no calculation)
3 = Pass output (no calculation)

type [int]

The matrix data type (default = char
Supported data types are char, long, float32, or float64.

MOP Messages

bang

Equivalent to the outputmatrix message.

clear

Sets all cell values in a matrix to zero.

exportattrs

Arguments

filename [symbol]
Exports an object's current attributes values in XML format. If no filename is specified, a file dialog will open to let you choose a file.

getattributes

Sends a sequence of lists out the object's right outlet describing the object's attributes, one line per attribute. Each line listing line takes the form attribute attribute-name get get-value set foo set-value data-type(s) number-of-values .

getstate

Sends a sequence of lists describing the object's state out the object's right outlet, one line per attribute. Each line listing line takes the form attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

importattrs

Arguments

filename [symbol]
Imports attributes specified in XML format to set the object's attributes. If no filename is specified, a file dialog will open to let you choose a file.

jit_matrix

Arguments

matrix-name [symbol]
Handles input for the named matrix. If this messages is received in the left inlet, output is typically triggered. If this message is received in any other inlet, the data is typically cached until the jit_matrix message is received in the left inlet.

outputmatrix

Sends the matrix out the left outlet.

summary

Sends a sequence of lists describing the object and it attributes and messages out the rightmost outlet of the object. The first output line takes the form summary objectname object-name . The second and third lines describe the number of inlets and outlets for the object in the form summary (matrixinputcount/matrixoutletcount) number-of-(inlets/outlets) . The fourth line describes the matrixoutput in the form summary matrixoutput descriptor planelink planelink-value typelink typelink-value dimlink dimlink-value types data-type(s) . Each attribute for the object is then listed, one attribute per line. Each line listing takes the form summary attribute attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

Attributes

acodec [symbol]

The audio codec for streaming (default = qdesign2)
The available codec types are none, raw, big16, little16, float32, float64, 24bit, 32bit, little32, mace3, mace6, cdxa4, cdxa2, ima, ulaw, alaw, adpcm, dviima, dvaudio, qdesign, qdesign2, qualcomm, mp3, vdva, mpeg4.

aenable [int]

Audio enable flag (default = 0)
This flag is only active in mode 2 (Sequence Grabber source mode) and determines whether sound will be streamed, as well as image.

aip [symbol]

Audio IP address (default = variable)
In multicast mode (the default. See unicast, below), this IP address is automatically assigned, and read-only, and refers to the special multicast address client computers access to reach your broadcast.
In unicast mode, this IP address should be set to the IP address of the single client computer.

aport [int]

Audio broadcast port number (default = 8556)
The network port to be used by the audio portion of the broadcast stream.

bitrate [int]

Audio bitrate (default = 16)
16 = 16-bit audio
8 = 8-bit audio

channels [int]

Audio channel selection (default = 2)
1 = mono audio
2 = stereo audio

codec [symbol]

The video codec for streaming (default = h263)
The following list of codecs is deprecated (retained for reference). See codeclist, below, for the preferred method to list valid system codecs.
The available codec types are raw, cinepak, graphics, animation, video, componentvideo, jpeg, mjpega, mjpegb, sgi, planarrgb, macpaint, gif, photocd, qdgx, avrjpeg, opendmljpeg, bmp, winraw, vector, qd, h261, h263, dvntsc, dvpal, dvprontsc, dvpropal, flc, targa, png, tiff, componentvideosigned, componentvideounsigned, cmyk, microsoft, sorenson, indeo4, argb64, rgb48, alphagrey32, grey16, mpegyuv420, yuv420, sorensonyuv9 and mpeg4.

codeclist [256 symbols]

g/s(get)

The valid video codecs available on the system
Sending the message getcodeclist 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.

datarate [int]

Sets the data rate in frames/second.

dstrect [4 ints]

The rectangular portion of the streaming image to be drawn to, when an incoming matrix is received. (default = 0 0 (image width) (image height))
The proportions of the rectangle are expressed in the form left top right bottom . All values are relative to the top left corner of the viewing area of the streamed image.

interp [int]

Interpolation flag (default = 0)

ip [symbol]

Video IP address (default = variable)
In multicast mode (the default. See unicast, below), this IP address is automatically assigned, and read-only, and refers to the special multicast address client computers access to reach your broadcast.
In unicast mode, this IP address should be set to the IP address of the single client computer.

kframe [int]

Keyframe rate (default = 50)
If set, the jit.qt.broadcast object will attempt to configure the video compressor to use the specified keyframe rate. Keyframes (temporal compression) are not available to all codecs.

mode [int]

Streaming source mode (default = 0)
0 = matrix input
1 = Hinted Movie input (uses the movie attribute to choose a pre-hinted source movie)
2 = Sequence Grabber input (uses an attached camera as the streaming source)
Modes 1 and 2 permit audio streaming, as well.

movie [symbol]

Source movie for mode 1 (default = "")
If no movie is specified when setting this attribute, a File dialog will be presented. Movies must be hinted, to be used with the jit.qt.broadcast object. See Tutorial 51: Broadcasting for more information.

preview [int]

Matrix preview flag (default = 0)
If set, an incoming matrix will be copied to the object's output matrix (with srcrect, interp or dstrect transformations) when the jit.qt.broadcast object is streaming. Otherwise, the matrix is simply passed through the object. Only functional in mode 0.

samplerate [float]

Audio sample rate (default = 8000)
48000 = 48kHz
44100 = 44.1kHz
32000 = 32kHz
22050 = 22.050kHz
22254 = 22kHz
16000 = 16kHz
11127 = 11kHz
11025 = 11.025kHz
8000 = 8000 Hz

size [2 ints]

The dimensions of the broadcast (default = 160 120)

spatialquality [symbol]

Codec spatial compression quality (default = 2 (normal))
0 or min = minimum
1 or low = low
2 or normal = normal
3 or high = high
4 or max = maximum
5 or lossless = lossless

Note that minimum quality is, in many cases, the codec's default quality. Use "low" quality for consistent results.

srcrect [4 ints]

The rectangular section of the incoming matrix to compress and stream (default = 0 0 (movie width) (movie height))

streamname [symbol]

Name of the broadcast stream, as displayed in the stream's URL (default = "Jitter")

temporalquality [symbol]

Codec temporal compression quality (default = 2 (normal))
0 or min = minimum
1 or low = low
2 or normal = normal
3 or high = high
4 or max = maximum
5 or lossless = lossless

Note that minimum quality is, in many cases, the codec's default quality. Use "low" quality for consistent results.

ttl [int]

Packet time to live (default = 255)

unicast [int]

Unicast broadcast flag (default = 0)
If set, the jit.qt.broadcast object will broadcast in unicast mode. In this mode, the vip (and aip, 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.

usedstrect [int]

Destination rect flag (default = 0)
When the flag is set, the dstrect attributes are used when compressing an input matrix for streaming.

usesrcrect [int]

Source rect flag (default = 0)
When the flag is set, the srcrect attributes are used when compressing an input matrix for streaming. The proportions of the rectangle are expressed in the form left top right bottom . All values are relative to the top left corner of the viewing area of the incoming matrix.

vcodec [symbol]

The video codec for streaming (default = h263)
Synonym for codec, above.

venable [int]

Video enable flag (default = 1)
This flag is currently ignored.

vip [symbol]

Video IP address (default = variable)
Synonym for ip, above.

vport [int]

Video broadcast port number (default = 8554)
The network port to be used by the video portion of the broadcast stream.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

pause

Pauses a running broadcast server. No effect if the server is idle.

start

Starts the broadcast server.

stop

Stops the broadcast server.

write

Arguments

filename []
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 (vcodec, for instance), a new SDP file must be written, or clients will have trouble connecting to the broadcast stream.
In the absence of a filename argument, a Save dialog will be presented.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
jit.net.recv Receive matrices from a jit.net.send object via TCP/IP
jit.net.send Send matrices to a jit.net.recv object via TCP/IP
jit.broadcast Broadcast video using RTSP