ActionBase.py

The ActionBase is the base for all action in StreamController. Therefore all your actions must extend this class.
ActionBase.py gives you easy access to the key(s) controlled by your actions, such as changing the image, getting events and so on.

If you want to learn more by going throught the code see this.

Available methods

set_deck_controller

Arguments:

Argument	Default	Description
deck_controller	None	The deck controller of the action.

Description:

Warning

This is an internal method, do not call it manually unless you know what you are doing.

This method gets called on the initialization of the action and sets the internal variable deck_controller.

set_page

Arguments:

Argument	Default	Description
page	None	The page of the action.

Description:

Warning

This is an internal method, do not call it manually unless you know what you are doing.

This method gets called on the initialization of the action and sets the internal variable page.

set_coords

Arguments:

Argument	Default	Description
coords	None	The coords of the action

Description:

Warning

This is an internal method, do not call it manually unless you know what you are doing.

This method gets called on the initialization of the action and sets the internal variable coords.

on_key_down

This method gets called when the action key is pressed. You can override this method in your action and add your own code.

Info

To ensure a lag-free experience for the user, all actions on the pressed keys are executed in a dedicated thread. This means you can add time consuming code here without affecting the application. However, any actions on the button after that will be delayed to ensure that the actions are always called in the same order.

on_key_up

This method gets called when the action key is released. You can override this method in your action and add your own code.

Info

To ensure a lag-free experience for the user, all actions on the released keys are executed in a dedicated thread. This means you can add time consuming code here without affecting the application. However, any actions on the button after that will be delayed to ensure that the actions are always called in the same order.

on_tick

This method gets called every second to allow live updates to the key. You can override this method in your action and add your own code.

Info

unlike on_key_down and on_key_up all actions on the same deck will be executed in the same thread. This means you are not supposed to add time consuming code here.

Warning

The next tick loop will start one second after the last one finished. This means should there be some actions that take a bit longer to finish their ticks the delays will grow. Therefore on_tick should neither be used for time consuming code nor for precize timing.

on_ready

This method gets called after the app is fully loaded and the decks are ready to process all types of requests.

Info

The constructor of all actions gets called before the actual decks are ready to process any requests for image changes. For that reason you should use on_ready for the intial image change instead of relying on the constructor.

set_default_image

Arguments:

Argument	Default	Description	Type
image	None	The image to use	PIL.Image

Description:
This sets the default image of the key. If the user or any other action tries to change the image their image will be used instead.

set_default_label

Arguments:

Argument	Default	Description	Type
text	None	The text to display	str
position	bottom	The position of the text relative to the key	str
color	[255, 255, 255]	The color of the text	list[int]
stroke_width	0	The stroke width of the text	int
font_family	""	The font family of the text	str
font_size	18	The font size of the text	int

Description:
This sets the default label of the key. If the user or any other action tries to change the label their label will be used instead.

Warning

This is not implemented yet. Changes made through this method will be ignored.

set_key

Arguments:

Argument	Default	Description	Type
image	None	The image to use	PIL.Image
media_path	None	The path to a media file	str
margins	[0, 0, 0, 0]	The margins of the image	list[int]
add_background	True	Whether to add the user chosen background to the key	bool
loop	True	Whether to loop the video	bool
fps	30	The frames per second of the video	int
bypass_task	False	Whether to bypass the task queue	bool
update_ui	True	Whether to update the UI	bool
reload	False	Internal argument, do not use unless you know what you are doing. This shows any changes made to the internal label variables.	bool

Description:
This is the method you can use to change the content of the key.
As you can see you can show images as well as videos in all major formats.

set_label

Arguments:

Argument	Default	Description	Type
text	None	The text to display	str
position	bottom	One of the three available positions: top, center or bottom	str
color	[255, 255, 255]	The color of the text	list[int]
stroke_width	0	The stroke width of the text	int
font_family	""	The font family of the text	str
font_size	18	The font size of the text	int
reload	True	Internal argument, do not use unless you know what you are doing. If set to True, this will run set_key with reload = True to apply the changes. Normally there is no reason to set this to False	bool

Description:
This method allows you write text in one of the three available positions: top, center or bottom onto the key.

set_top_label

Arguments:

Argument	Default	Description	Type
text	None	The text to display	str
color	[255, 255, 255]	The color of the text	list[int]
stroke_width	0	The stroke width of the text	int
font_family	""	The font family of the text	str
font_size	18	The font size of the text	int
reload	True	Internal argument, do not use unless you know what you are doing. If set to True, this will run set_key with reload = True to apply the changes. Normally there is no reason to set this to False	bool

Description:
This method has the same outcome as set_label with position = "top".

set_center_label

Arguments:

Argument	Default	Description	Type
text	None	The text to display	str
color	[255, 255, 255]	The color of the text	list[int]
stroke_width	0	The stroke width of the text	int
font_family	""	The font family of the text	str
font_size	18	The font size of the text	int
reload	True	Internal argument, do not use unless you know what you are doing. If set to True, this will run set_key with reload = True to apply the changes. Normally there is no reason to set this to False	bool

Description:
This method has the same outcome as set_label with position = "center".

set_bottom_label

Arguments:

Argument	Default	Description	Type
text	None	The text to display	str
color	[255, 255, 255]	The color of the text	list[int]
stroke_width	0	The stroke width of the text	int
font_family	""	The font family of the text	str
font_size	18	The font size of the text	int
reload	True	Internal argument, do not use unless you know what you are doing. If set to True, this will run set_key with reload = True to apply the changes. Normally there is no reason to set this to False	bool

Description:
This method has the same outcome as set_label with position = "bottom".

get_config_rows

Description:
This method can be overritten by your action to show configuration rows in the ui.

Example from the OS Plugin

Returns:
A list of Adw.PreferencesRow objects.

get_custom_config_area

Description:
This method can be overritten by your action to show a custom area in the ui. By allowing all Gtk.Widgets you are able to customize the config area completely to your needs.

Returns:
Any Gtk.Widget

set_settings

Arguments:

Argument	Description	Type
settings	A dictionary with your settings	dict

Description:
This method allows you to store settings for your actions. The typical usage is to store the user settings made in the custom config area. You then use get_settings to retrieve them.

The dict gets directly written into the page json and will be kept if the page gets exported or duplicated. This looks like this:

"actions": [
            {
                "name": "dev_core447_MediaPlugin::Info",
                "settings": {
                    "show_thumbnail": true,
                    "show_label": true,
                    "seperator_text": ""
                }
            }
        ]

get_settings

Description:
This method returns a dictionary with all your set settings for this action. For more see set_settings.

Returns:
A dictionary with your settings

connect

Arguments:

Argument	Default	Description	Type
signal	None	The signal to connect to	Signal
callback	None	A callback method	callable

Description:
This method allows you to connect to signals allowing you to adapt to important changes made through the ui. For example if you are working with page names you might want to connect to the page rename signal to get notified when that happens and change the internal references accordingly.
On how to use signals see How to use signals.