Class Pipeline
Definition
- Assembly:
- Tizen.MachineLearning.Inference.dll
The Pipeline class provides interfaces to create and execute stream pipelines with neural networks.
public class Pipeline : IDisposable
- Inheritance
-
objectPipeline
- Implements
-
System.IDisposable
Constructors
View SourcePipeline(string)
Creates a new Pipeline instance with the given pipeline description
Declaration
public Pipeline(string description)
Parameters
Type | Name | Description |
---|---|---|
string | description | The pipeline description. Refer to GStreamer manual or NNStreamer documentation for examples and the grammar. |
Remarks
http://tizen.org/privilege/mediastorage is needed if pipeline description is relevant to media storage.
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
System.UnauthorizedAccessException | Thrown when the application does not have the required privilege. |
System.InvalidOperationException | Thrown when the method failed due to the wrong pipeline description or internal error. |
Properties
View SourceState
The state of pipeline.
Declaration
public PipelineState State { get; }
Property Value
Type | Description |
---|---|
PipelineState |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.InvalidOperationException | Thrown when failed to get the pipeline state. |
Methods
View SourceDispose()
Releases any unmanaged resources used by this object.
Declaration
public void Dispose()
Dispose(bool)
Releases any unmanaged resources used by this object including opened handle.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | If true, disposes any disposable objects. If false, does not dispose disposable objects. |
~Pipeline()
Destructor of the Pipeline instance.
Declaration
protected ~Pipeline()
GetNormal(string)
Gets the normal node instance with given node name.
Declaration
public Pipeline.Node GetNormal(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of normal node. |
Returns
Type | Description |
---|---|
Pipeline.Node | The normal node instance |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
GetSink(string)
Gets the sink node instance with given node name.
Declaration
public Pipeline.SinkNode GetSink(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of sink node |
Returns
Type | Description |
---|---|
Pipeline.SinkNode | The sink node instance |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
GetSource(string)
Gets the source node instance with given node name.
Declaration
public Pipeline.SourceNode GetSource(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of source node |
Returns
Type | Description |
---|---|
Pipeline.SourceNode | The source node instance |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
GetSwitch(string)
Gets the switch node instance with given node name.
Declaration
public Pipeline.SwitchNode GetSwitch(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of switch node. |
Returns
Type | Description |
---|---|
Pipeline.SwitchNode | The switch node instance |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
GetValve(string)
Gets the valve node instance with given node name.
Declaration
public Pipeline.ValveNode GetValve(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of valve node |
Returns
Type | Description |
---|---|
Pipeline.ValveNode | The valve node instance |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
Start()
Starts the pipeline, asynchronously. (The state would be changed to PipelineState.Playing)
Declaration
public void Start()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.InvalidOperationException | Thrown when failed to start the pipeline. |
Stop()
Stops the pipeline, asynchronously. (The state would be changed to PipelineState.Paused)
Declaration
public void Stop()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.InvalidOperationException | Thrown when failed to stop the pipeline. |
Events
View SourceStateChanged
Event to be invoked when the pipeline state is changed.
Declaration
public event EventHandler<StateChangedEventArgs> StateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><StateChangedEventArgs> |