broadcasterctl(1) Mac OS X Server Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X Server version 10.6.3

If you are running Mac OS X (client), this command is not available.

If you are running a different version of Mac OS X Server, view the documentation locally:

In Xcode
In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


BROADCASTERCTL(1)                                                                          BROADCASTERCTL(1)



NAME
       broadcasterctl - controller for the QuickTime Broadcaster

SYNOPSIS
       broadcasterctl  [-b  broadcaster-path]  [-a  audiopreset]  [-v  videopreset]  [-n  networkpreset] [-t
       (audio|video|av)] [-r (record|norecord)] [-p recording-path]  [-f  settingsfile]  (config|status|pre-sets|launch|start|stop|restart|quit) (config|status|presets|launch|start|stop|restart|quit)
       sets|launch|start|stop|restart|quit)

DESCRIPTION
       broadcasterctl  is  a  command line tool for controlling the QuickTime Broadcaster application. Using
       broadcasterctl you can configure, launch, start, and stop a QuickTime streaming  broadcast  generated
       by the MacOS X QuickTime Broadcaster application.

       The QuickTime Broadcaster application must be accessable on the local host on which the terminal ses-sion session
       sion is exectuting in order to communicate with that application. (i.e. It will not control a network
       remote copy of the application.)

OPTIONS
       The following command line options can be invoked with broadcasterctl:

       config Sets  the  configuration  of the QuickTime Broadcaster application to be that of the currently
              specified settings file.

       status Returns the current status QuickTime Broadcaster application.

       presets
              Sets the presets of the QuickTime Broadcaster application to be that of the  currently  speci-fied specified
              fied preset values.

       launch Launches the QuickTime Broadcaster application.

       start  Tells the QuickTime Broadcaster application to begin the broadcast.

       stop   Tells the QuickTime Broadcaster application to stop the broadcast.

       restart
              Tells the QuickTime Broadcaster application to restart the broadcast.

       quit   Causes the QuickTime Broadcaster application to quit.

       -a audiopreset
              Specifies  the  the current audio preset configuration to be the name given in the audiopreset
              parameter.

       -b broadcaster-path
              Specifies the file path to the QuickTime Broadcaster application.

       -f settingsfile
              Specifies the file path to the broadcast settings file.

       -n networkpreset
              Specifies the the current network preset configuration to be the name given in the networkpre-set networkpreset
              set parameter.

       -p recording-path
              Specifies the file path to record the broadcast to.

       -r (record|norecord)
              Controls whether or not the QuickTime Broadcaster will record the broadcast to a file as it is
              broadcasting the stream. Specify record to record the broadcast and norecord  to  do  nothing.
              (The default is the norecord option.)

       -t (audio|video|av)
              Specifies  the type of broadcast to be originated. Specifiy audio for an audio-only broadcast,
              video for an video-only broadcast, or av for a combination audio/video broadcast.

       -v videopreset
              Specifies the the current video preset configuration to be the name given in  the  videopreset
              parameter.

SEE ALSO
       QuickTimeStreamingServer(1), ps(1), kill(1)

LIMITATIONS
       Only one audio, video, or audio/video session can be controlled per invokation of broadcasterctl.



Apple Computer, Inc.                           August 16, 2002                             BROADCASTERCTL(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?