Table of Contents

Method GetInputPropertiesListPropertyItems

Namespace
OBSStudioClient
Assembly
OBSClient.dll

GetInputPropertiesListPropertyItems(InputRef, string, CancellationToken)

Gets the items of a list property from an input's properties.

public Task<PropertyItem[]> GetInputPropertiesListPropertyItems(InputRef input, string propertyName, CancellationToken cancellationToken = default)

Parameters

input InputRef

The input, by name or by UUID.

propertyName string

Name of the list property to get the items of.

cancellationToken CancellationToken

A token that ends the wait for the response, which makes the method throw an OperationCanceledException. A request that was already sent is not undone: OBS Studio may still carry it out.

Returns

Task<PropertyItem[]>

Array of items in the list property.

Remarks

Note: Use this in cases where an input provides a dynamic, selectable list of items. For example, display capture, where it provides a list of available displays.