Clic - An Application for Setting up NMM Multimedia Flow Graphs

Motama GmbH, Saarbruecken, Germany

http://www.motama.com

April 2007

  Copyright (C) 2007,
  Motama GmbH, Saarbruecken, Germany
  http://www.motama.com
 
  Permission is granted to copy, distribute and/or modify this
  document under the terms of the GNU Free Documentation License,
  Version 1.2 or any later version published by the Free Software
  Foundation; with the Invariant Sections being all sections, no
  Front-Cover Texts, and no Back-Cover Texts. A copy of the license
  can be found in the file COPYING.FDL.

  THE DOCUMENT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
  NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE
  DISTRIBUTING THE DOCUMENT BE LIABLE FOR ANY DAMAGES OR OTHER
  LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
  OF OR IN CONNECTION WITH THE DOCUMENT OR THE USE OR OTHER DEALINGS
  IN THE DOCUMENT.

This document describes the usage of the application 'clic' (command line interaction and configuration) used in the NMM project to build up a flow graph from a textual description. Furthermore, clic allows to use the graph builder of NMM that automatically creates a distributed flow graph from a given URL.


Table of Contents
1. Introduction
2. Syntax of the graph description
2.1. Creating flow graphs
3. Node specific Parameters
3.1. setLocation
3.2. setPort
3.3. setSharingType
4. Configuration parameters
4.1. Interface methods
4.2. setEventStrategy
5. Using the Graph Builder
5.1. file
5.2. audiocd
5.3. dvd
5.4. tv
5.5. dvbtv
5.6. ivtv
5.7. mpegtv
5.8. http
6. Using the Graph Builder for Distributed Media Playback
7. Keyboard Control
A. Graph descriptions
A.1. Playback
A.2. Recording
A.3. Transcoding
A.4. Session Sharing

1. Introduction

The NMM framework is used to build up multimedia applications. The basic components in this framework are nodes which perform a certain functionality, like reading a video file or decoding it. Such nodes can be connected to a flow graph to perform a certain task like watching a movie or transcoding it into another format.

Especially transcoder jobs do not need any additional user interaction if the application is running. Writing such an application without any user interaction is currently straightforward. First, the application requests these nodes from the registry, connects them to a flow graph and finally starts the entire flow graph.

The application clic is used to build such a standard NMM application automatically from a textual description which is called 'graph description'. This document describes the syntax of this graph description and the usage of the clic-application.

Furthermore, clic allows to use the graph builder of NMM that automatically creates a distributed flow graph from a given URL: the source of media, the audio output, and the video output can be distributed.

Please note that all following examples were tested on Linux only, unless otherwise indicated. Therefore, some node names or settings need to be changed when running the examples on other operating systems. Examples for other operating systems are provided with the corresponding NMM package.