Interface IPlayableCollectionGroupChildrenBase
A collection of IPlayableCollectionGroupBases and the properties and methods for using and manipulating them.
Inherited Members
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IPlayableCollectionGroupChildrenBase : IPlayableCollectionBase, IPlayableCollectionItem, IPlayableBase, IImageCollectionBase, IUrlCollectionBase, ICollectionBase, ICollectionItemBase
Properties
| Improve this Doc View SourceTotalChildrenCount
The total number of available Children.
Declaration
int TotalChildrenCount { get; }
Property Value
Type | Description |
---|---|
int |
Methods
| Improve this Doc View SourceIsAddChildAvailableAsync(int, CancellationToken)
Checks if the backend supports adding an IPlayableCollectionGroupBase at a specific index.
Declaration
Task<bool> IsAddChildAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, an item can be added. |
IsRemoveChildAvailableAsync(int, CancellationToken)
Checks if the backend supports removing an IPlayableCollectionGroupBase at a specific index.
Declaration
Task<bool> IsRemoveChildAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, the item can be removed. |
PausePlayableCollectionGroupAsync(CancellationToken)
Attempts to play the playable collection. Resumes if paused.
Declaration
Task PausePlayableCollectionGroupAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
PlayPlayableCollectionGroupAsync(CancellationToken)
Attempts to play the playable collection. Resumes if paused.
Declaration
Task PlayPlayableCollectionGroupAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
RemoveChildAsync(int, CancellationToken)
Removes the child from the collection on the backend.
Declaration
Task RemoveChildAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | The index of the child to remove. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Events
| Improve this Doc View SourceChildrenCountChanged
Fires when the merged TotalChildrenCount changes.
Declaration
event EventHandler<int>? ChildrenCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |