Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/plugin_dev/advanced_concepts/DeckController.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The [DeckController](DeckController.md) is a high-level object that allows you to control [Stream Decks](https://www.elgato.com/uk/en/s/welcome-to-stream-deck). It builds on top of the [Stream Deck](https://github.com/abcminiuser/python-elgato-streamdeck/blob/master/src/Stream Deck/Devices/Stream Deck.py) class of the [python-elgato-streamdeck](https://github.com/abcminiuser/python-elgato-streamdeck) library.
It manages the backgrounds, videos, labels and gives plugins and StreamController itself a nice interface.

Under normal conditions you should not need to use this object directly because all important methods are make available through the [ActionBase](../bases/ActionBase_py.md). However, if you want to write an action with more deeply integration like for example changing the background, you will need to call methods on [DeckController](DeckController.md) directly.
Under normal conditions you should not need to use this object directly because all important methods are made available through [ActionCore](../bases/ActionCore_py.md). However, if you want to write an action with more deeply integration like for example changing the background, you will need to call methods on [DeckController](DeckController.md) directly.
2 changes: 1 addition & 1 deletion docs/plugin_dev/advanced_concepts/PageCaching.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ However, it's important to be aware of its existence to circumvent potential iss
Despite this, it's a common pitfall. Why? Because when a user navigates away from a page and then returns, your action's state might still be in the cache. Consequently, your plugin may falsely assume the correct image is displayed when, in fact, it is not.

: **Solution:**
: To address this, simply reset the `current_state` variable within the [`on_ready`](../bases/ActionBase_py.md#on_ready) method. The `on_ready` method is invoked each time a page is loaded, allowing you to reset the `current_state` variable.
: To address this, simply reset the `current_state` variable within the [`on_ready`](../bases/ActionCore_py.md#on_ready) method. The `on_ready` method is invoked each time a page is loaded, allowing you to reset the `current_state` variable.
6 changes: 3 additions & 3 deletions docs/plugin_dev/advanced_concepts/Signals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Signals are called when special actions are performed in the ui, allowing the plugin to respond to these actions. For example, should your plugin have some kind of page selection in the [config area](../bases/ActionBase_py.md#get_config_rows) your plugin needs to get informed if a page gets renamed. That's exactly what signals are for.
Signals are called when special actions are performed in the ui, allowing the plugin to respond to these actions. For example, should your plugin have some kind of page selection in the [config area](../bases/ActionCore_py.md#get_config_rows) your plugin needs to get informed if a page gets renamed. That's exactly what signals are for.

## Available signals

Expand Down Expand Up @@ -61,12 +61,12 @@ Signals are called when special actions are performed in the ui, allowing the pl
from src.Signals import Signals
```
2. Connect to the signal
This is done by the [`connect`](../bases/ActionBase_py.md#connect) method of the [`ActionBase`](../bases/ActionBase_py.md):
This is done by the [`connect`](../bases/ActionCore_py.md#connect) method of [ActionCore](../bases/ActionCore_py.md):
```python
self.connect(signal=Signals.PageRename, callback=self.on_page_rename)
```
3. Done !!
Now every time a page gets renamed the `on_page_rename` method will be called.

## Not enough?
Should you need a signal that is currently not availble feel free to open a [issue](https://github.com/Core447/StreamController/issues) or work on an own [pull request](https://github.com/Core447/StreamController/pulls).
Should you need a signal that is currently not availble feel free to open a [issue](https://github.com/StreamController/StreamController/issues) or work on an own [pull request](https://github.com/StreamController/StreamController/pulls).
297 changes: 0 additions & 297 deletions docs/plugin_dev/bases/ActionBase_py.md

This file was deleted.

Loading