zapIMediaGraph Interface Reference
[ZAP Media Kit (ZMK) module]

import "zapIMediaGraph.idl";

List of all members.

Public Member Functions
ACString	addNode (in ACString type, in nsIPropertyBag2 node_pars)
	Create and add node of 'type' and return its unique id in the graph.
ACString	addExternalNode (in zapIMediaNodeRawPtr node, in nsIPropertyBag2 node_pars)
	Insert the given existing node into the graph and return an id identifying it within this graph.
void	removeNode (in ACString id_or_alias)
	Remove the given node.
void	getNode (in ACString id_or_alias, in nsIIDRef uuid, in boolean synchronous,[iid_is(uuid), retval] out nsQIResult result)
	Obtain a proxied interface for the given node.
void	setAlias (in ACString alias, in ACString id_or_alias)
	Set or move alias to point to id_or_alias.
ACString	connect (in ACString source_node, in nsIPropertyBag2 source_pars, in ACString sink_node, in nsIPropertyBag2 sink_pars)
	Connect source to sink and return id for the connection.
void	disconnect (in ACString connection_id)
	Break the connection identified by connection_id.
void	shutdown ()
	Shutdown this mediagraph instance.

---

Member Function Documentation

ACString zapIMediaGraph::addExternalNode (  in zapIMediaNodeRawPtr  node, in nsIPropertyBag2  node_pars )

Insert the given existing node into the graph and return an id identifying it within this graph. Note that the node will be accessed on the media thread, so in general must be threadsafe if constructed/accessed on different threads. 'node' be a pointer to an object implementing zapIMediaNode. It is of type zapIMediaNodeRawPtr in the IDL to prevent it from being auto-proxified.

ACString zapIMediaGraph::addNode (  in ACString  type, in nsIPropertyBag2  node_pars )

Create and add node of 'type' and return its unique id in the graph. The node will instantiated from the contractid "@mozilla.org/zap/medianode;type='type'". The node implementation does not need to be threadsafe; it will only be accessed on the media thread. Callers from external threads can obtain access to thread-proxied interfaces on the node through zapIMediaGraph::getNode().

ACString zapIMediaGraph::connect (  in ACString  source_node, in nsIPropertyBag2  source_pars, in ACString  sink_node, in nsIPropertyBag2  sink_pars )

Connect source to sink and return id for the connection. This method will always fail if the media graph is locked. See lock()/unlock().

void zapIMediaGraph::disconnect (  in ACString  connection_id  )

Break the connection identified by connection_id. This method will always fail if the media graph is locked. See lock()/unlock()

void zapIMediaGraph::getNode (  in ACString  id_or_alias, in nsIIDRef  uuid, in boolean  synchronous, [iid_is(uuid), retval] out nsQIResult  result )

Obtain a proxied interface for the given node.

void zapIMediaGraph::removeNode (  in ACString  id_or_alias  )

Remove the given node. This method will always fail if the media graph is locked. See lock()/unlock()

void zapIMediaGraph::setAlias (  in ACString  alias, in ACString  id_or_alias )

Set or move alias to point to id_or_alias. Alias MUST NOT start with the special letter '#' which is reserved as a node id prefix.

void zapIMediaGraph::shutdown (   )

Shutdown this mediagraph instance. This method will always fail if the media graph is locked. See lock()/unlock()

---

The documentation for this interface was generated from the following file:

• /home/alex/devel/zap/mozilla/zap/zmk/src/zapIMediaGraph.idl

---