csengine package

Subpackages

Submodules

csengine.CSOverlay module

csengine.audiochannel module

class csengine.audiochannel.AudioChannel(type, channelNr=0)

Bases: object

CHUNK = 1024

ReaderThread()

activeStack = None

busy = False

channel = None

channelNr = 0

openOutputChannel()

readerThread = None

shutdown = False

write(chunk)

csengine.csmediafile module

class csengine.csmediafile.csmediafile(filename)

Bases: object

CHUNK_BYTES = 1024

DELAY_CHUNKS = 0

DISPOSE_FRAMES = 0

EMPTY_AUDIO = b'\x00\x00\x00\x00\x00'

arraySize = 0

audioCallback = None

audioPipe = None

audioProcess = None

audioReader = None

audioReadyEvent = None

audioStdErrReader = None

audioVideoSyncFrames = 0

calcDurationString(msec)

currentAudioFrames = 0

currentFrame = None

durationStr = ''

enableAudio = True

enableVideo = True

filename = None

framerate = 0

getCurrentFrame()

getDurationMsec()

getMediaInformation()

getVideoPosition()

h = 0

hasAudio = False

hasVideo = False

height = 0

isPaused = False

isPlaying = False

min = 0

msec = 0

outputStream = None

pa = None

pause()

pauseEvent = None

play(seek='')

playFrom(msec)

readAudio()

readAudioStderr()

readVideo()

readVideoStderr()

scale = ''

sec = 0

shutdown = False

stop()

syncCounter = 0

testThread()

totalFrames = 0

totalSamples = 0

videoFrameCount = 0

videoPipe = None

videoProcess = None

videoReader = None

videoReadyEvent = None

videoStdErrReader = None

videoSyncEvent = None

videoSyncTimer = None

width = 0

csengine.easycv module

Module: easycv.py

This module defines the function that will make it easier to work with OpenCV. A plugin can directly engage with OpenCV using import cv2 statement, but many frequently used operations can be done using the functions in this module.

The methods are all static and there is no need to create an instance of the class CVEssentials

class csengine.easycv.CVEssentials

Bases: object

static OverlayImage(frame, overlay, xPos, yPos, overlay_size)

This function overlays one image over the provided frame at the provided x and y positions scaled to a specific size.

Make sure that the overlay image does not go out of bounds when overlaying.The provided frame should be greater than the size of the overlay plus it’s position values.

Parameters:

• frame (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – The frame on which the image will be overlayed

• overlay (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – The image frame to overlay on the original frame

• xPos (int) – The x position of where the overlay will start

• yPos (int) – The y position of where the overlay will start

• overlay_size (tuple (width,height)) – The dimensions of the image to be overlayed

Returns:

Returns the frame after overlaying image over the current frame

Return type:

numpy.ndarray, shape (height, width, channels), dtype uint8 or float32

static OverlayTransparent(background_img, img_to_overlay_t, x, y, blur=5, overlay_size=(640, 480))

Overlays a transparant PNG onto another image using CV2

Parameters:

• background_img (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – The background image

• img_to_overlay_t (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – The transparent image to overlay (has alpha channel)

• x (int) – x location to place the top-left corner of our overlay

• y (int) – y location to place the top-left corner of our overlay

• overlay_size (int[]) – The size to scale our overlay to (tuple), no scaling if None

• blur (float) – The Blur amount for corner smoothing

Returns:

Background image with overlay on top

Return type:

int[]

static RemoveColorRange(frame, background, brights, darks, dim, blur=0)

Removes a range of color pixels from the frame and replaces with background. This function can be used for effects like Green/Blue Screen

Parameters:

• frame (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – the main front frame as numpty array

• background – the frame that needs to replace the color range

• brights (float array as [b,g,r] values) – the upper color range of colors in [b, g, r] format

• darks (float array as [b,g,r] values) – the lower color range of colors in [b, g, r] format

• dim (tuple (width, height)) – dimensions of the frame as tuple (width, height)

Returns:

frame which has all pixels of provided color range in frame, replaced by background

Return type:

frame as numpy.ndarray, shape (height, width, channels), dtype uint8 or float32

static RemovePixelsOfColor(image, red, blue, green)

Converts all pixels in an image of a certain color to transparent using cv2 and numpy

Parameters:

• image (numpy.ndarray, shape (height, width, channels), dtype uint8 or float32) – The image matrix.

• red (int (0-255)) – The red color value for the color to be removed.

• blue (int (0-255)) – The blue color value for the color to be removed.

• green (int (0-255)) – The green color value for the color to be removed.

Returns:

bgra with all black pixels converted to transparent

Return type:

numpy.ndarray, shape (height, width, channels), dtype uint8 or float32

static resizeWithAspectRatio(curr_height, curr_width, image, scale)

static showErrorOnVideo(frame, error_message, color=(0, 0, 255))

static showPreview(frame)

static showPreviewWindow(frame)

csengine.emptypluginbase module

@Name: Empty Plugin Parent Template @Description: This is the Empty Plugin Class that will be parent class to empty plugins that can be

shipped with the application. These empty plugins lead you to the download page.

@Created on: Jan-2022 @Created by: Vinimay Kaul @Last Modified: 21-Jan-2022 @Last Modified by: Vinimay Kaul

class csengine.emptypluginbase.EmptyPluginBase(**kwargs)

Bases: object

Represents am Empty Plugin Base Template with its properties and methods.

Variables:

• normalBG (str) – The path to the Background Image to be shown as a thumbnail in CamSkool for the plugin. (Default: “”)

• downBG (str) – The path to the MouseOver Image to be shown when the user mouseovers the thumbnail. (Default: “”)

• controllerBG (str) – The path to the Background Image to be shown in the plugin’s controller. (Default: “”)

• name (str) – The name of the Plygin as shown in the application. (Default: “Sample Plugin”)

• description (str) – The short description of the plugin that will be used in the app. (Default: “No Information available.”)

• tags_raw (str) – The tags for the plugin that will be used in search. (Default: “plugin,camskool,untagged”)

• plugin_path (str) – The path where the plugin will be installed or found. This path should always be CEEnvironment.GetFullPluginsPath() / plugin_name, unless you specifically want to install the plugin at a different location.

• type – This value defines where the plugin will show up in the app. The type of plugin decides wehre it shows.

The values have to be “ANIM”, “IMAGE” or “TOOL”. The names can be confusing because the design process and ideas about plugin types and categories changed over time but the values are still the same as the first categorisations. Changing this in the code is easy, but it will mean that all the plugins have to be recompiled and resigned and re-uploaded. (Default: “TOOL”) :vartype type: str :ivar platform: This value was used to make sure that the platform specific plugins could be made. Check globals class for options like globals.COMPATIBILITY_ALL, globals.COMPATIBILITY_WIN_ONLY, globals.COMPATIBILITY_MAC_ONLY :vartype platform: int :ivar stackable: This value allows the application to know if this plugin can be stacked over other plugins or not. Some plugins cannot be stacked over other plugins because of their functionality, but most plugins can be. (Default: False) :vartype stackable: bool :ivar infoImagePath: :vartype infoImagePath: :ivar iconImage: :vartype iconImage: :ivar downloadLink: :vartype downloadLink: :ivar pipes: The pipes array used to communicate between modules. :vartype pipes: pipes Array :ivar writerEvent: A Thread Event used to write the Audio data :vartype writerEvent: threads.Event :ivar audioReRoute: Value defines if the Audio will be rerouted to the speakers or not :vartype audioReRoute: bool :ivar requiresRGB: This value determines if the frame needs to return the RGB value or RGBA. If true then frames will be returned as RGBA else RGB :vartype requiredRG: bool

AddPluginToList()

ObservePlatformCompatibility()

audioOverlayChannel = None

audioReRoute = False

callback_posChange(instance, value)

createFavoritesUI()

createPluginUI()

createSearchListUI()

downloadPlugin(*args)

getItemRating()

getTotalVotes()

onMouseOver(*args)

pipes = []

requiresRGB = False

showPluginInfo(instance)

updateLayoutPosition(*args)

writerEvent = None

csengine.fileuploader module

class csengine.fileuploader.Uploader

Bases: object

ENDPOINT = '/upload'

IP = '165.232.144.123'

PORT = '8000'

upload(file)

csengine.globals module

@Name: Cam Engine Globals @Description: This file includes all the global variables that need

to be accessed by the application from various locations.

@Created on: Feb-2021 @Created by: Vinimay Kaul @Last Modified: 27-Feb-2021 @Last Modified by: Vinimay Kaul

class csengine.globals.ActivePlugin

Bases: object

active_plugin = None

active_slide = None

static getActivePlugin()

static getActiveSlide()

static setActivePlugin(plugin)

static setActiveSlide(slide)

slideObject = None

class csengine.globals.ApplicationScreens

Bases: object

AnimationsScreen = None

static GetAnimationsScreen()

static GetPnSScreen()

static GetSearchScreen()

static GetToolsScreen()

PnSScreen = None

SearchScreen = None

static SetAnimationsScreen(anims)

static SetPnSScreen(pns)

static SetSearchScreen(search)

static SetToolsScreen(tools)

ToolsScreen = None

class csengine.globals.CEEnvironment

Bases: object

AppDataFolder = WindowsPath('.')

static GetAppDataFolder()

static GetAppFolder()

static GetFullPluginsPath()

static GetPluginFolder()

KEY_STORE = ''

static SetAppDataFolder(path)

TEST_MODE_ACTIVE = False

csengine.overlay module

csengine.pluginbase module

Module: csengine/pluginbase.py

This module contains the Basic Plugin Class that needs to be inherited by all Plugins.

class csengine.pluginbase.PluginBase(**kwargs)

Bases: object

This is the base class for all plugins that need to be made for CamSkool application. All plugins need to inherit this class and overwrite the following functions:

• modifyController() - Override this function in subclass to modify the controller UI. If not overridden it will show an emtpy controller. Use self.controllerCanvas.add_widget(YOUR MAIN WIDGET HERE)

• getFrame() - This function is called every Frame. Override this function to change the frame t be shown

• dropFrame() - This function is called in case another frame is still being processes - so we drop one frame to hold the framerate

• play() - This function is called immediately after the Controller is created and made visible. Add any code in the function override that needs to run when the controller is visible.

• stop() - This function is called when the controller is closed and the confirm dialog is also YES

• preload() - Override this function to put anything that needs to be completed before the plugin opens.

Variables:

• normalBG (str) – The path to the Background Image to be shown as a thumbnail in CamSkool for the plugin. (Default: “”)

• downBG (str) – The path to the MouseOver Image to be shown when the user mouseovers the thumbnail. (Default: “”)

• controllerBG (str) – The path to the Background Image to be shown in the plugin’s controller. (Default: “”)

• name (str) – The name of the Plygin as shown in the application. (Default: “Sample Plugin”)

• description (str) – The short description of the plugin that will be used in the app. (Default: “No Information available.”)

• tags_raw (str) – The tags for the plugin that will be used in search. (Default: “plugin,camskool,untagged”)

• plugin_path (str) – The path where the plugin will be installed or found. This path should always be CEEnvironment.GetFullPluginsPath() / plugin_name, unless you specifically want to install the plugin at a different location.

• type (str) – This value defines where the plugin will show up in the app. The type of plugin decides wehre it shows. The values have to be “ANIM”, “IMAGE” or “TOOL”. The names can be confusing because the design process and ideas about plugin types and categories changed over time but the values are still the same as the first categorisations. Changing this in the code is easy, but it will mean that all the plugins have to be recompiled and resigned and re-uploaded. (Default: “TOOL”)

• platform (int) – This value was used to make sure that the platform specific plugins could be made. Check globals class for options like globals.COMPATIBILITY_ALL, globals.COMPATIBILITY_WIN_ONLY, globals.COMPATIBILITY_MAC_ONLY

• stackable (bool) – This value allows the application to know if this plugin can be stacked over other plugins or not. Some plugins cannot be stacked over other plugins because of their functionality, but most plugins can be. (Default: False)

• infoImagePath (str) – This is the relative path for the Plugin Info Image.

• iconImage (str) – This is the relative path for the Plugin’s icon image.

• downloadLink (str) – This is the url for this plugin’s download link in the store.

AddPluginToList()

ObservePlatformCompatibility()

accept()

activatePlugin()

addRemoveFavorites(instance)

applyAudioChannelGain(gain)

applyAudioMainGain(gain)

audioMonitorToggle(*args)

audioOverlayChannel = None

audioReRoute = False

callback_posChange(instance, value)

This function is deprecated and will be removed in a future version since it is no longer required.

closeController(*args)

closeLoader(*args)

createAudioInput()

createAudioOutput(bufferSize=None)

createFavoritesUI()

Creates Favorites List. Not functional as of now

createMenuButtons()

createPluginUI()

createSearchListUI()

The function that creates the UI for the plugin in the Search Window. This is different from the main screen list of plugins. You can add/delete/modify anything on the plugin Search UI here.

deactivatePlugin()

disconnectAudioPort(pipe)

dropFrame()

This function is called in case another frame is still being processes - so we drop one frame to hold the frame rate

Returns:

void

getAudio(chunk)

getFrame(cam_frame)

This function is called every Frame. Override this function to change the frame to be returned every time the Video Engine calls this function.

Modify the frame by using openCV functions or pre-made function ins csengine.easycv.py and return the modified frame.

Returns:

Returns the modified frame.

Return type:

numpy.array image

getItemRating()

This function is called to fetch the plugin item’s rating information. This is currently hardcoded as no online rating system is available on the CamSkool website.

Returns:

A rating value

Return type:

float

getTotalVotes()

This function is called to fetch the plugin item’s votes information. This is currently hardcoded as no online voting system is available on the CamSkool website.

Returns:

A voting value

Return type:

int

isPreloadComplete(dt)

minimizeController(controller, animate=True)

modifyController()

Override this function in the child plugin class to modify how the controller looks. You can change the look and feel of the controller, add controls and functionality in this function.

Returns:

Returns the Kivy Parent Layout for the controller. Add controls and Listeners to the Plugin Controller and return the parent Layout.

Return type:

kivy.uix.gridlayout

onAudioMonitorReady(connected)

onMouseOver(*args)

This function is called whenever there is a Mouseover detected on the thumbnail of the plugin on the Plugin List Screens of CamSkool. Whatever changed need to be made to the plugin Thumbnail on mouseover need to be added here.

openPlugin(*args)

This function is called when the user clicks the “Open” button of the plugin or opens the plugin from anywhere. This function then adds the current plugin to the current stack in the current classroom.

Returns:

void

pipes = []

play()

This function is called immediately after the Controller is created and made visible. Add any code in the function override that needs to run when the controller is visible. This is called whenever the plugin is loaded or initialized.

Returns:

void

playAudioFile(filepath, *args)

pluginDismiss()

preload()

Override this function to put anything that needs to be completed before the plugin opens.

Returns:

void

registerAudioLevelCallbacks()

reject()

requiresRGB = False

restoreController(animate=True)

restoreWindowSize()

This function when called restores the window size from whatever the current window size is to the original window size with an animation

return: void

setWindowSize(x, y)

Call this function to resize the application window to the desired size with animation.

Parameters:

• x (int) – The new desired width

• y (int) – The new desired height

Returns:

void

showController(*args)

showPluginInfo(instance)

This function is called when the user clicks on the Info button. This function will then show a popup box with all the relevant information.

Parameters:

instance (PluginBase) – The instance of the current PluginBase class

Returns:

void

startPreload(*args)

stop()

This function is called when the controller is closed and the confirm dialog is also YES

Returns:

void

updateLayoutPosition(*args)

Call back function for UI updates

writeAudioOverlay(chunk)

writerEvent = None

csengine.slides module

class csengine.slides.Slides

Bases: object

addPluginToActiveStack(pluginObject)

addSlide()

initAudio()

inputAudioChannel = None

makeNewInstance(pluginObject)

makeSelectionActive(index)

overlayAudioChannels = [None, None, None]

removeSlide(index)

shutdown()

csengine.stack module

class csengine.stack.Stack(slides, name)

Bases: object

addToStack(pluginObject)

audioChannelBusy = [False, False, False]

dropFrame()

getAudio(chunk)

getFrame(frame)

openSelectedController(index)

removeFromStack(pluginObject)

shutdown = False

updateStackButtons()

csengine.tkinter module

class csengine.tkinter.TkinterAPI

Bases: object

EM_Message = 'An Error Occured!'

EM_title = 'Error'

KiVY_CLK_INTV_FOCUSED = 0.5

KiVY_CLK_INTV_UNFOCUSED = 0.05

TkkivyClock = None

aboutScreenVisible = False

static askOKCancel(title='Information', message='This is just an Information')

static askQuestion(title='Information', message='This is just an Information')

static askRetryCancel(title='Information', message='This is just an Information')

static askYesNo(title='Information', message='This is just an Information')

static askYesNoCancel(title='Information', message='This is just an Information')

changeKivyClockSpeed(focused)

static closeAbout(master)

color = None

fileTypes = [['All Files', '*.*']]

focus_last = True

getMaster()

static pI()

path = ''

runMainLoop(x)

static selectColor()

static selectFile(fileType)

static showAboutScreen()

static showErrorMessage(title='Error', message='An Error Occurred')

static showInfoMessage(title='Information', message='This is just an Information')

static showSplashScreen()

static showWarningMessage(title='Warning', message='Warning!')

startCETK()

stopCETK()

tkMaster = None

csengine.uix module

@Name: Cam Engine UI Elements @Description: This file includes all the reusable UI Elements or UI elements that

the plugins need to access from within the application.

@Created on: Dec-2020 @Created by: Vinimay Kaul @Last Modified: 26-Dec-2022 @Last Modified by: Vinimay Kaul

class csengine.uix.BoxLayoutX(**kwargs)

Bases: BoxLayout

set_bgcolor(r, b, g, o)

update_rect(*args)

class csengine.uix.ControlsScreen(**kwargs)

Bases: Popup

controller_popup

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

game_icon

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

game_name

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

class csengine.uix.InputTextDialog(**kwargs)

Bases: ModalView

onEnter(*args)

show(callback)

validate(*args)

class csengine.uix.ItemIcon(**kwargs)

Bases: Image

makeIcon()

class csengine.uix.ItemInformationBox(**kwargs)

Bases: Popup

closeInfo(*args)

emptyDef(*args, **kwargs)

getDescKV()

getInfoScrollView(itemDesc)

getSeparator()

getStarImage(value)

makeRatingStars(value)

onOpen(*args, **kwargs)

show()

uninstallPlugin(*args, **kwargs)

class csengine.uix.LabelX(**kwargs)

Bases: Label

set_bgcolor(r, b, g, o)

update_rect(*args)

class csengine.uix.LoginScreen(**kwargs)

Bases: Screen

on_kv_post(base_widget)

class csengine.uix.MainScreen(sm=None, **kwargs)

Bases: Screen

screen_manager

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

class csengine.uix.MenuScreen(**kw)

Bases: Screen

static LoadAllPlugins()

static RefreshPlugins(refresh=False)

help_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

help_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

on_enter()

play_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

play_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

rewards_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

rewards_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

search_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

search_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

settings_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

settings_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

showUpcoming(item)

sidebarMenuGL

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

stackButtonClicked(instance, index)

tools_btn

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

tools_btn_D

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

class csengine.uix.Notification(*args, **kwargs)

Bases: FloatLayout

autoClose(*args)

closeNotification(*args)

messageLabel

StringProperty(defaultvalue=u’’, **kw) Property that represents a string value.

Parameters:

defaultvalue: string, defaults to ‘’

Specifies the default value of the property.

notiLayout

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

notify(text, auto_close=True)

resetNotification(*args)

class csengine.uix.PopUpOK(**kwargs)

Bases: Popup

closePop(*args)

show()

class csengine.uix.PopUpYESNO(**kwargs)

Bases: Popup

emptyDef(*args)

onNoClicked(instance)

onYesClicked(instance)

show()

class csengine.uix.RPCustomMessagePopup(**kwargs)

Bases: Popup

action = ''

button_caption

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

caller = None

message

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

message_popup

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

class csengine.uix.RPMessagePopup(**kwargs)

Bases: Popup

caller = None

message

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

message_popup

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

class csengine.uix.RPValidatePopup(**kwargs)

Bases: Popup

caller = None

message

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

validate_popup

ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.

Parameters:

defaultvalue: object type

Specifies the default value of the property.

rebind: bool, defaults to False

Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes.

That is the standard behavior is that if there’s a kv rule text: self.a.b.c.d, where a, b, and c are properties with rebind False and d is a StringProperty. Then when the rule is applied, text becomes bound only to d. If a, b, or c change, text still remains bound to d. Furthermore, if any of them were None when the rule was initially evaluated, e.g. b was None; then text is bound to b and will not become bound to d even when b is changed to not be None.

By setting rebind to True, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever b changes or becomes not None if it was None before, text is evaluated again and becomes rebound to d. The overall result is that text is now bound to all the properties among a, b, or c that have rebind set to True.

**kwargs: a list of keyword arguments

baseclass

If kwargs includes a baseclass argument, this value will be used for validation: isinstance(value, kwargs[‘baseclass’]).

Warning

To mark the property as changed, you must reassign a new python object.

Changed in version 1.9.0: rebind has been introduced.

Changed in version 1.7.0: baseclass parameter added.

class csengine.uix.RewardsScreen(**kw)

Bases: Screen

class csengine.uix.RoundedButton(**kwargs)

Bases: Button

emptyFunction()

makeFullButton()

makeHalfButton()

makeQuarterButton()

class csengine.uix.ScatterX(**kwargs)

Bases: Scatter

Init = False

apply_transform(trans, post_multiply=False, anchor=(0, 0))

Transforms the scatter by applying the “trans” transformation matrix (on top of its current transformation state). The resultant matrix can be found in the transform property.

Parameters:

trans: Matrix.

Transformation matrix to be applied to the scatter widget.

anchor: tuple, defaults to (0, 0).

The point to use as the origin of the transformation (uses local widget space).

post_multiply: bool, defaults to False.

If True, the transform matrix is post multiplied (as if applied before the current transform).

Usage example:

from kivy.graphics.transformation import Matrix
mat = Matrix().scale(3, 3, 3)
scatter_instance.apply_transform(mat)

do_rotation = False

Allow rotation.

do_rotation is a BooleanProperty and defaults to True.

frameHeight = 480

frameWidth = 640

on_touch_move(touch)

Receive a touch move event. The touch is in parent coordinates.

See on_touch_down() for more information.

on_touch_up(touch)

Receive a touch up event. The touch is in parent coordinates.

See on_touch_down() for more information.

outOfRange = False

videoHeight = 0

videoOffsetX = 0

videoOffsetY = 0

videoWidth = 0

wOffset = (0, 0)

wSize = (0, 0)

class csengine.uix.SearchScreen(**kw)

Bases: Screen

closeSearch()

search(keywords)

sortByWeight(item)

class csengine.uix.ShowNTellScreen(**kw)

Bases: Screen

class csengine.uix.ShowWaiting(**kwargs)

Bases: ModalView

close()

createLoader(text)

show(text)

class csengine.uix.SideBarMenu(**kwargs)

Bases: FloatLayout

class csengine.uix.SideMenuScreen(**kw)

Bases: Screen

activateTestMode(*args)

reportBug(instance)

showHideSideMenu()

showSplashScreen()

showUpcoming(item)

submitReport(ipop, ti, *args)

uploadBug(*args)

class csengine.uix.SlideScreen(**kw)

Bases: Screen

addSlide()

changeButtonName(text)

changeName()

definiteDelete()

enableButton(index)

firstEnter = True

onSlideClicked(btn_Instance, index)

on_enter()

rebuildSlides(activeIndex)

removeSlide()

slideLimit = 18

stackButtonClicked(instance, index)

class csengine.uix.ToolsScreen(**kw)

Bases: Screen

class csengine.uix.TrackPad

Bases: object

createScatter(width, height)

getPosition()

getSize()

getWidget()

scatter = None

widget = None

class csengine.uix.VUMeter(width)

Bases: object

getWidget()

update(val)

class csengine.uix.ValidatePopup(**kwargs)

Bases: Popup

csengine.utility module

@Name: Cam Engine Utilities @Description: This file includes all the Utility Classes. These are used by

the Core application as well as the Plugins.

@Created on: Feb-2021 @Created by: Vinimay Kaul @Last Modified: 17-March_2021 @Last Modified by: Vinimay Kaul

class csengine.utility.DebugUtility

Bases: object

static Debug(data)

static Err(data, i, console='')

FORMATTER = <logging.Formatter object>

static InspectFrame()

LOG_FILE = 'C:\\CSLOGS\\logs.txt'

LOG_LIFE_TIME = 3

static Log(data)

static LogToFile(data, filename)

static Print(data)

static activatePrint(activate=True)

static closeLogging()

static csExceptionHook(type, value, err_traceback)

debugFile = None

debugToFile = None

exc_hook = None

frozen = False

static get_console_handler()

static get_file_handler(logfile)

static get_logger(logger_name, level, logfile)

static initLogging()

log_level = 0

log_path = './'

logfile = None

printActive = False

static purgeOldLogs()

stderr_buf = None

class csengine.utility.FileUtility

Bases: object

static ReadAllFromFile(filepath, filename)

static ReadLineNumberFromFile(filepath, filename, index)

static ReadLinesFromFile(filepath, filename, amount)

static SaveBinaryToFile(filepath, filename, filedata)

static SaveToFile(filepath, filename, filedata, append=False)

class csengine.utility.FireBaseUtility

Bases: object

uploadFilefilePath(cloudFileName, localFileName)

class csengine.utility.MiscUtility

Bases: object

static Decrypt(data)

static Encrypt(data)

static SetupAppFolder()

class csengine.utility.NotificationUtility

Bases: object

NotificationObject = None

static notify(message, auto_close=True)

static setNotificationObject(object)

class csengine.utility.OSUtility

Bases: object

static CreateMacPath(user, pth)

static CreateWindowsPath(user, pth)

Execute(path)

ExecuteNonBlocking()

static ExpandMacPath(user, m_path)

static GetMacBundlePath()

static GetPlatformID()

static GetWindowsBundlePath()

static InstallMacCamLib(application_path, plugin_path, pkg_path, audio_plugin_path)

static MakeMacPath(folder_path)

static Restart(testMode=False)

static isPluginsInstalled(application_path, plugin_path, pkg_path, audio_plugin_path)

class csengine.utility.PluginUtility

Bases: object

static ActivatePlugins()

static BrowsePlugins(ns_pkg)

static GetAllPlugins(ns_pkg)

static LoadFavoritesFromFile(pluginObject)

Plg_Anim_List = []

Plg_Favorites = []

Plg_Img_List = []

Plg_SEffect_List = []

Plg_SearchResults = []

Plg_SearchWeights = []

Plg_Sound_List = []

Plg_Tool_List = []

static SaveFavoritesToFile()

static searchAnim(searchText)

static searchImage(searchText)

static searchTool(searchText)

static searchUtility(keywords, searchType='all')

static validatePlugin(name)

Module contents