Class Pipeline

View Source

Definition

Namespace:
Tizen.MachineLearning.Inference
Assembly:
Tizen.MachineLearning.Inference.dll
API Level:
8

The Pipeline class provides interfaces to create and execute stream pipelines with neural networks.


                
C#

                

                    
Copy

                    

                

            
public class Pipeline : IDisposable
Inheritance
Object
Pipeline

Constructors

View Source

Pipeline(String)

Creates a new Pipeline instance with the given pipeline description

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference

Properties

View Source

State

The state of pipeline.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PipelineState State { get; }
Property Value
Type Description
PipelineState
API Level: 8

Methods

View Source

Dispose()

Releases any unmanaged resources used by this object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
API Level: 8
View Source

Dispose(Boolean)

Releases any unmanaged resources used by this object including opened handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

If true, disposes any disposable objects. If false, does not dispose disposable objects.
API Level: 8
View Source

Finalize()

Destructor of the Pipeline instance.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected void Finalize()
API Level: 8
View Source

GetNormal(String)

Gets the normal node instance with given node name.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

GetSink(String)

Gets the sink node instance with given node name.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

GetSource(String)

Gets the source node instance with given node name.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

GetSwitch(String)

Gets the switch node instance with given node name.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

GetValve(String)

Gets the valve node instance with given node name.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

Start()

Starts the pipeline, asynchronously. (The state would be changed to PipelineState.Playing)

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Start()
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference
View Source

Stop()

Stops the pipeline, asynchronously. (The state would be changed to PipelineState.Paused)

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Stop()
API Level: 8
Feature: http://tizen.org/feature/machine_learning.inference

Events

View Source

StateChanged

Event to be invoked when the pipeline state is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<StateChangedEventArgs> StateChanged
Event Type
Type Description
EventHandler<StateChangedEventArgs>
API Level: 8

Extension Methods