VideoSink

---

Object Hierarchy:

Description:

Content:

Properties:

• public int update_priority { set; get; }

Creation methods:

• public VideoSink (Context ctx)
  Creates a new VideoSink which will create resources for use with the given context.

Methods:

• public void attach_frame (Pipeline pln)
  Updates the given pipeline with the textures for the current frame.
• public void fit_size (Rectangle available, ref Rectangle output)
  Calculates a suitable output rectangle that can fit inside the available space while maintaining the aspect ratio of the current video.
• public float get_aspect ()
  Returns a width-for-height aspect ratio that lets you calculate a suitable width for displaying your video based on a given height by multiplying your chosen height by the returned aspect ratio.
• public int get_free_layer ()
  This can be used when doing specialised rendering of the video by customizing the pipeline.
• public float get_height_for_width (float width)
  Calculates a suitable output height for a specific output width that will maintain the video's aspect ratio.
• public float get_natural_height ()
  Considering the real resolution of the video as well as the aspect ratio of pixel data that may need to be stretched when being displayed; this function calculates what the natural size of the underlying video source is, and returns its height.
• public void get_natural_size (out float width, out float height)
  Considering the real resolution of the video as well as the aspect ratio of pixel data that may need to be stretched when being displayed; this function calculates what the natural size of the underlying video source is.
• public float get_natural_width ()
  Considering the real resolution of the video as well as the aspect ratio of pixel data that may need to be stretched when being displayed; this function calculates what the natural size of the underlying video source is, and returns its width.
• public weak Pipeline get_pipeline ()
  Returns a pipeline suitable for rendering the current frame of the given video sink.
• public float get_width_for_height (float height)
  Calculates a suitable output width for a specific output height that will maintain the video's aspect ratio.
• public Bool is_ready ()
  Returns whether the pipeline is ready and so get_pipeline and setup_pipeline can be called without causing error.
• public void set_context (Context ctx)
  Sets the Context that the video sink should use for creating any resources.
• public void set_default_sample (Bool default_sample)
  By default the pipeline generated by setup_pipeline and get_pipeline will have a layer with a shader snippet that automatically samples the video.
• public void set_first_layer (int first_layer)
  Sets the index of the first layer that the sink will use for its rendering.
• public void setup_pipeline (Pipeline pipeline)
  Configures the given pipeline so that will be able to render the video for the this.

Signals:

• public virtual signal void new_frame ()
  The sink will emit this signal whenever there are new textures available for a new frame of the video.
• public virtual signal void pipeline_ready ()
  The sink will emit this signal as soon as it has gathered enough information from the video to configure a pipeline.

Inherited Members: