Stream usage information. More...

Inheritance diagram for libcamera::StreamUsage:

Public Types
enum	Role { StillCapture, VideoRecording, Viewfinder }
	Identify the role a stream is intended to play. More...

Public Member Functions
Role	role () const
	Retrieve the stream role. More...

const Size &	size () const
	Retrieve desired size. More...

Protected Member Functions
	StreamUsage (Role role)
	Create a stream usage. More...

	StreamUsage (Role role, const Size &size)
	Create a stream usage with a desired size. More...

Detailed Description

Stream usage information.

The StreamUsage class describes how an application intends to use a stream. Usages are specified by applications and passed to cameras, that then select the most appropriate streams and their default configurations.

Member Enumeration Documentation

◆ Role

enum libcamera::StreamUsage::Role

Identify the role a stream is intended to play.

Enumerator
StillCapture	The stream is intended to capture high-resolution, high-quality still images with low frame rate. The captured frames may be exposed with flash.
VideoRecording	The stream is intended to capture video for the purpose of recording or streaming. The video stream may produce a high frame rate and may be enhanced with video stabilization.
Viewfinder	The stream is intended to capture video for the purpose of display on the local screen. The StreamUsage includes the desired resolution. Trade-offs between quality and usage of system resources are acceptable.

Constructor & Destructor Documentation

◆ StreamUsage() [1/2]

libcamera::StreamUsage::StreamUsage ( Role role )

explicitprotected

Create a stream usage.

Parameters

[in] role Stream role

◆ StreamUsage() [2/2]

libcamera::StreamUsage::StreamUsage	(	Role	role,
		const Size &	size
	)

protected

Create a stream usage with a desired size.

Parameters

[in]	role	Stream role
[in]	size	The desired size

Member Function Documentation

◆ role()

libcamera::StreamUsage::role ( ) const

inline

Retrieve the stream role.

Returns: The stream role

◆ size()

libcamera::StreamUsage::size ( ) const

inline

Retrieve desired size.

Returns: The desired size

The documentation for this class was generated from the following files:

include/libcamera/stream.h
src/libcamera/stream.cpp

Public Types

Public Member Functions

Protected Member Functions