MediaOutputUrlInterface Class Reference

#include <mediasession_output.h>

Inheritance diagram for MediaOutputUrlInterface:

Detailed Description

The MediaOutputInterface class provides an specific implementation to provide output data to a given destination.

Public Member Functions
MAXON_METHOD Url	GetOutputUrl () const
MAXON_METHOD Result< void >	SetOutputUrl (const Url &url)
MAXON_METHOD const FileFormat &	GetFileFormat () const
MAXON_METHOD Result< Bool >	EditSystemOptions (DataDictionary &settings, const Delegate< Result< void * >()> &getParentwindowHandle)
MAXON_METHOD Result< DrawDimensionInt >	CheckBitmapSize (const DataDictionary &settings, const DrawDimensionInt &bitmapSize) const

Private Member Functions
	MAXON_INTERFACE (MediaOutputUrlInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.mediaoutputurl", MAXON_IMPLEMENTATION_MODULE("net.maxon.image"))

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( MediaOutputUrlInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.image.interface.mediaoutputurl"  , MAXON_IMPLEMENTATION_MODULE("net.maxon.image")    )

private

GetOutputUrl()

MAXON_METHOD Url GetOutputUrl

(

)

const

Returns the output url.

SetOutputUrl()

MAXON_METHOD Result<void> SetOutputUrl

(

const Url &

url

)

Sets the url to which this output converter should write it's data.

Parameters

[in]

url

Url to write to.

Returns

OK on success.

GetFileFormat()

MAXON_METHOD const FileFormat& GetFileFormat

(

)

const

Returns the corresponding file format.

EditSystemOptions()

MAXON_METHOD Result<Bool> EditSystemOptions	(	DataDictionary &	settings,
		const Delegate< Result< void * >()> &	getParentwindowHandle
	)

EditSystemOptions opens a system compressor options dialog to allow the user to choose compressor settings for a specific codec.

Parameters

[in,out]	settings	Settings to be displayed and modified. After calling the function the DataDictionary contains the new settings.
[in]	getParentwindowHandle	Callback to return the parent window handle. Windows: return the HWND for the parent.

Returns

True if the user pressed OK, false if the user cancelled the action. FunctionNotImplementedError if the output handler doesn't support a dialog.

CheckBitmapSize()

MAXON_METHOD Result<DrawDimensionInt> CheckBitmapSize	(	const DataDictionary &	settings,
		const DrawDimensionInt &	bitmapSize
	)		const

Verifies the given resolution for the save format (e.g. mp4 quantizes the width to the next 16 boundary).

Parameters

[in]	settings	Save Settings.
[in]	bitmapSize	Given input bitmap size.

Returns

Corrected bitmap size if the save cannot handle the given size, otherwise the given size.