unreal.MediaStreamSourceBlueprintLibrary

class unreal.MediaStreamSourceBlueprintLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Deals with creating new Media Stream Sources.

C++ Source:

  • Plugin: MediaStream

  • Module: MediaStream

  • File: MediaStreamSourceBlueprintLibrary.h

classmethod is_asset_path_valid(path) → bool

Checks the Asset path to see if it’s a valid asset for a Media Stream Source.

Parameters:

path (str) – The asset path to check.

Returns:

True if the asset is valid.

Return type:

bool

classmethod is_asset_soft_path_valid(path) → bool

Checks the Asset soft path to see if it’s a valid asset for a Media Stream Source.

Parameters:

path (SoftObjectPath) – The asset soft path to check.

Returns:

True if the asset is valid.

Return type:

bool

classmethod is_asset_valid(asset) → bool

Checks the Asset pointer to see if it’s a valid asset for a Media Stream Source.

Parameters:

asset (Object) – The asset to check.

Returns:

True if the asset is valid.

Return type:

bool

classmethod is_valid_media_source(source) → bool

Checks the media stream to see if its source type is none or set to something valid. And that the path is not empty.

Parameters:

source (MediaStreamSource) – The source to check.

Returns:

True if the source is valid. Does not guarantee it is correct, only valid.

Return type:

bool

classmethod make_media_source_from_asset(media_stream, asset) → MediaStreamSource

Create a Media Stream Source from an Asset. Must have a registered handler.

Parameters:
Returns:

A valid stream source object or none if it was not a valid object.

Return type:

MediaStreamSource

classmethod make_media_source_from_file(media_stream, file_name) → MediaStreamSource

Create a Media Stream Source from a file name.

Parameters:

  • media_stream (MediaStream) – The owning Media Stream

  • file_name (str) – The path to the file name. Should be a full path or relative to the project or engine root.

Returns:

A valid stream source object or none if the file was not found.

Return type:

MediaStreamSource

classmethod make_media_source_from_scheme_path(media_stream, scheme, path) → MediaStreamSource

Create a Media Stream Source from an Asset. Must have a registered handler.

Parameters:

  • media_stream (MediaStream) – The owning Media Stream

  • scheme (Name) – The scheme of the source.

  • path (str) – The path to the source.

Returns:

A valid stream source object or none if it was not a valid object.

Return type:

MediaStreamSource

classmethod make_media_source_from_stream_name(media_stream, stream_name) → MediaStreamSource

Create a Media Stream Source from a stream name. Must be set up via the Media Source Manager.

Parameters:

  • media_stream (MediaStream) – The owning Media Stream

  • stream_name (Name) – The name of the registered stream.

Returns:

A valid stream source object or none if it was not a valid stream or the stream was not found.

Return type:

MediaStreamSource

classmethod make_media_source_from_subobject(media_stream, object) → MediaStreamSource

Create a Media Stream Source from an object.

Parameters:

  • media_stream (MediaStream) – The owning Media Stream

  • object (Object) – The playable object. Should share a common ancestor with the Media Stream, but this is not enforced.

Returns:

A valid stream source object or none if the file was not found.

Return type:

MediaStreamSource

classmethod make_media_source_from_subobject_class(media_stream, class_) → MediaStreamSource

Create a Media Stream Source by instantiating the given class.

Parameters:

  • media_stream (MediaStream) – The owning Media Stream

  • class (type(Class)) – The class of a playable object.

Returns:

A valid stream source object or none if the file was not found.

Return type:

MediaStreamSource