Skip to main content

app

                            
                              
                                import
                                
                                {
                                ...
                                }
                                
                                from
                                
                                "@motion-canvas/core/lib/app"
                                ;

Main Motion Canvas classes.

Enumerations ​

  • LogLevel
  • PlaybackState
  • PresenterState
  • RendererResult
  • RendererState

Classes ​

  • Logger
  • PlaybackStatus
  • Player
  • Presenter
  • ProjectMetadata
  • Renderer
  • Stage

Interfaces ​

  • Exporter
  • ExporterClass
  • LogPayload
  • PlayerSettings
  • PlayerState
  • PresenterInfo
  • PresenterSettings
  • Project
  • ProjectSettings
  • RendererSettings
  • StageSettings
  • Versions

Type Aliases ​

SettingsMetadata ​ 

                            
                              
                                type 
                                SettingsMetadata
                                 = 
                                ReturnType
                                
                                  
                                    
                                      typeof 
                                      createSettingsMetadata

A runtime representation of the settings metadata.

Functions ​

createSettingsMetadata ​ 

                            
                              
                                public 
                                createSettingsMetadata
                                (): 
                                ObjectMetaField
                                
                                  
                                    
                                      
                                        
                                          
                                            appearance
                                            : 
                                            ObjectMetaField
                                            
                                              
                                                
                                                  
                                                    
                                                      
                                                        color
                                                        : 
                                                        ColorMetaField
                                                         = 
                                                        ...
                                                      
                                                      
                                                        coordinates
                                                        : 
                                                        BoolMetaField
                                                         = 
                                                        ...
                                                      
                                                      
                                                        font
                                                        : 
                                                        BoolMetaField
                                                         = 
                                                        ...
                                                      
                                                    
                                                  
                                                
                                              
                                            
                                             = 
                                            ...
                                          
                                          
                                            defaults
                                            : 
                                            ObjectMetaField
                                            
                                              
                                                
                                                  
                                                    
                                                      
                                                        background
                                                        : 
                                                        ColorMetaField
                                                         = 
                                                        ...
                                                      
                                                      
                                                        size
                                                        : 
                                                        Vector2MetaField
                                                         = 
                                                        ...
                                                      
                                                    
                                                  
                                                
                                              
                                            
                                             = 
                                            ...
                                          
                                          
                                            version
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  number
                                                
                                              
                                            
                                             = 
                                            ...

Create a runtime representation of the settings metadata.

makeProject ​ 

                            
                              
                                public 
                                makeProject
                                
                                  
                                    
                                      settings
                                      : 
                                      ProjectSettings
                                    
                                  
                                
                                : 
                                ProjectSettings

Parameters