OpenShot Video Editor  2.0.0
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
timeline_webview.TimelineWebView Class Reference

A WebView QWidget used to load the Timeline. More...

Inheritance diagram for timeline_webview.TimelineWebView:
updates.UpdateInterface

Public Member Functions

def __init__ (self, window)
 
def add_missing_transition (self, transition_json)
 
def addClip (self, data, position)
 
def addEffect (self, effect_names, position)
 
def addSelection (self, item_id, item_type, clear_existing=False)
 Add the selected item to the current selection. More...
 
def addTransition (self, file_ids, position)
 
def Align_Triggered (self, action, clip_ids, tran_ids)
 Callback for alignment context menus. More...
 
def Animate_Triggered (self, action, clip_ids, position="Entire Clip")
 Callback for the animate context menus. More...
 
def changed (self, action)
 
def ClearAllSelections (self)
 Clear all selections in JavaScript. More...
 
def contextMenuEvent (self, event)
 
def Copy_Triggered (self, action, clip_ids, tran_ids)
 Callback for copy context menus. More...
 
def dragEnterEvent (self, event)
 
def dragLeaveEvent (self, event)
 A drag is in-progress and the user moves mouse outside of timeline. More...
 
def dragMoveEvent (self, event)
 
def dropEvent (self, event)
 
def eval_js (self, code)
 
def Fade_Triggered (self, action, clip_ids, position="Entire Clip")
 Callback for fade context menus. More...
 
def Hide_Waveform_Triggered (self, clip_ids)
 Hide the waveform for the selected clip. More...
 
def keyPressEvent (self, event)
 Keypress callback for timeline. More...
 
def Layout_Triggered (self, action, clip_ids)
 Callback for the layout context menus. More...
 
def movePlayhead (self, position_frames)
 Move the playhead since the position has changed inside OpenShot (probably due to the video player) More...
 
def page_ready (self)
 Document.Ready event has fired, and is initialized. More...
 
def Paste_Triggered (self, action, position, layer_id, clip_ids, tran_ids)
 Callback for paste context menus. More...
 
def PlayheadMoved (self, position_seconds, position_frames, time_code)
 
def PreviewClipFrame (self, clip_id, frame_number)
 
def qt_log (self, message=None)
 
def RazorSliceAtCursor (self, clip_id, trans_id, cursor_position)
 Callback from javascript that the razor tool was clicked. More...
 
def redraw_audio_onTimeout (self)
 Timer is ready to redraw audio (if any) More...
 
def removeSelection (self, item_id, item_type)
 Remove the selected clip from the selection. More...
 
def render_cache_json (self)
 Render the cached frames to the timeline (called every X seconds), and only if changed. More...
 
def resizeTimeline (self, new_duration)
 Resize the duration of the timeline. More...
 
def Reverse_Transition_Triggered (self, tran_ids)
 Callback for reversing a transition. More...
 
def Rotate_Triggered (self, action, clip_ids, position="Start of Clip")
 Callback for rotate context menus. More...
 
def round_to_multiple (self, number, multiple)
 Round this to the closest multiple of a given #. More...
 
def SelectAll (self)
 Select all clips and transitions in JavaScript. More...
 
def SetRazorMode (self, enable_razor)
 Enable / Disable razor mode. More...
 
def SetSnappingMode (self, enable_snapping)
 Enable / Disable snapping mode. More...
 
def setup_js_data (self)
 
def show_all_clips (self, clip, stretch=False)
 Show all clips at the same time (arranged col by col, row by row) More...
 
def Show_Waveform_Triggered (self, clip_ids)
 Show a waveform for the selected clip. More...
 
def ShowClipMenu (self, clip_id=None)
 
def ShowEffectMenu (self, effect_id=None)
 
def ShowMarkerMenu (self, marker_id=None)
 
def ShowPlayheadMenu (self, position=None)
 
def ShowTimelineMenu (self, position, layer_id)
 
def ShowTrackMenu (self, layer_id=None)
 
def ShowTransitionMenu (self, tran_id=None)
 
def Slice_Triggered (self, action, clip_ids, trans_ids, playhead_position=0)
 Callback for slice context menus. More...
 
def Split_Audio_Triggered (self, action, clip_ids)
 Callback for split audio context menus. More...
 
def Time_Triggered (self, action, clip_ids, speed="1X", playhead_position=0.0)
 Callback for rotate context menus. More...
 
def Transform_Triggered (self, action, clip_ids)
 
def update_clip_data (self, clip_json, only_basic_props=True, ignore_reader=False)
 Create an updateAction and send it to the update manager. More...
 
def update_transition_data (self, transition_json, only_basic_props=True)
 Create an updateAction and send it to the update manager. More...
 
def update_zoom (self, newValue)
 
def UpdateClipThumbnail (self, clip_data)
 Update the thumbnail image for clips. More...
 
def Volume_Triggered (self, action, clip_ids, position="Entire Clip")
 Callback for volume context menus. More...
 
def Waveform_Ready (self, clip_id, audio_data)
 Callback when audio waveform is ready. More...
 
def wheelEvent (self, event)
 
- Public Member Functions inherited from updates.UpdateInterface
def changed (self, action)
 This method is invoked each time the UpdateManager is changed. More...
 

Public Attributes

 cache_renderer
 
 cache_renderer_version
 
 copy_clipboard
 
 copy_transition_clipboard
 
 document_is_ready
 
 item_id
 
 item_type
 
 last_position_frames
 
 new_item
 
 redraw_audio_timer
 
 settings
 
 window
 

Static Public Attributes

 html_path = os.path.join(info.PATH, 'timeline', 'index.html')
 

Detailed Description

A WebView QWidget used to load the Timeline.

Definition at line 160 of file timeline_webview.py.

Constructor & Destructor Documentation

◆ __init__()

def timeline_webview.TimelineWebView.__init__ (   self,
  window 
)

Definition at line 2864 of file timeline_webview.py.

Member Function Documentation

◆ add_missing_transition()

def timeline_webview.TimelineWebView.add_missing_transition (   self,
  transition_json 
)

Definition at line 297 of file timeline_webview.py.

◆ addClip()

def timeline_webview.TimelineWebView.addClip (   self,
  data,
  position 
)

Definition at line 2572 of file timeline_webview.py.

◆ addEffect()

def timeline_webview.TimelineWebView.addEffect (   self,
  effect_names,
  position 
)

Definition at line 2709 of file timeline_webview.py.

◆ addSelection()

def timeline_webview.TimelineWebView.addSelection (   self,
  item_id,
  item_type,
  clear_existing = False 
)

Add the selected item to the current selection.

Definition at line 2462 of file timeline_webview.py.

◆ addTransition()

def timeline_webview.TimelineWebView.addTransition (   self,
  file_ids,
  position 
)

Definition at line 2662 of file timeline_webview.py.

◆ Align_Triggered()

def timeline_webview.TimelineWebView.Align_Triggered (   self,
  action,
  clip_ids,
  tran_ids 
)

Callback for alignment context menus.

Definition at line 1480 of file timeline_webview.py.

◆ Animate_Triggered()

def timeline_webview.TimelineWebView.Animate_Triggered (   self,
  action,
  clip_ids,
  position = "Entire Clip" 
)

Callback for the animate context menus.

Definition at line 1123 of file timeline_webview.py.

◆ changed()

def timeline_webview.TimelineWebView.changed (   self,
  action 
)

Definition at line 183 of file timeline_webview.py.

◆ ClearAllSelections()

def timeline_webview.TimelineWebView.ClearAllSelections (   self)

Clear all selections in JavaScript.

Definition at line 2827 of file timeline_webview.py.

◆ contextMenuEvent()

def timeline_webview.TimelineWebView.contextMenuEvent (   self,
  event 
)

Definition at line 410 of file timeline_webview.py.

◆ Copy_Triggered()

def timeline_webview.TimelineWebView.Copy_Triggered (   self,
  action,
  clip_ids,
  tran_ids 
)

Callback for copy context menus.

Definition at line 1294 of file timeline_webview.py.

◆ dragEnterEvent()

def timeline_webview.TimelineWebView.dragEnterEvent (   self,
  event 
)

Definition at line 2539 of file timeline_webview.py.

◆ dragLeaveEvent()

def timeline_webview.TimelineWebView.dragLeaveEvent (   self,
  event 
)

A drag is in-progress and the user moves mouse outside of timeline.

Definition at line 2798 of file timeline_webview.py.

◆ dragMoveEvent()

def timeline_webview.TimelineWebView.dragMoveEvent (   self,
  event 
)

Definition at line 2742 of file timeline_webview.py.

◆ dropEvent()

def timeline_webview.TimelineWebView.dropEvent (   self,
  event 
)

Definition at line 2755 of file timeline_webview.py.

◆ eval_js()

def timeline_webview.TimelineWebView.eval_js (   self,
  code 
)

Definition at line 171 of file timeline_webview.py.

◆ Fade_Triggered()

def timeline_webview.TimelineWebView.Fade_Triggered (   self,
  action,
  clip_ids,
  position = "Entire Clip" 
)

Callback for fade context menus.

Definition at line 1565 of file timeline_webview.py.

◆ Hide_Waveform_Triggered()

def timeline_webview.TimelineWebView.Hide_Waveform_Triggered (   self,
  clip_ids 
)

Hide the waveform for the selected clip.

Definition at line 906 of file timeline_webview.py.

◆ keyPressEvent()

def timeline_webview.TimelineWebView.keyPressEvent (   self,
  event 
)

Keypress callback for timeline.

Definition at line 2508 of file timeline_webview.py.

◆ Layout_Triggered()

def timeline_webview.TimelineWebView.Layout_Triggered (   self,
  action,
  clip_ids 
)

Callback for the layout context menus.

Definition at line 1046 of file timeline_webview.py.

◆ movePlayhead()

def timeline_webview.TimelineWebView.movePlayhead (   self,
  position_frames 
)

Move the playhead since the position has changed inside OpenShot (probably due to the video player)

Definition at line 2437 of file timeline_webview.py.

◆ page_ready()

def timeline_webview.TimelineWebView.page_ready (   self)

Document.Ready event has fired, and is initialized.

Definition at line 168 of file timeline_webview.py.

◆ Paste_Triggered()

def timeline_webview.TimelineWebView.Paste_Triggered (   self,
  action,
  position,
  layer_id,
  clip_ids,
  tran_ids 
)

Callback for paste context menus.

Definition at line 1367 of file timeline_webview.py.

◆ PlayheadMoved()

def timeline_webview.TimelineWebView.PlayheadMoved (   self,
  position_seconds,
  position_frames,
  time_code 
)

Definition at line 2422 of file timeline_webview.py.

◆ PreviewClipFrame()

def timeline_webview.TimelineWebView.PreviewClipFrame (   self,
  clip_id,
  frame_number 
)

Definition at line 2400 of file timeline_webview.py.

◆ qt_log()

def timeline_webview.TimelineWebView.qt_log (   self,
  message = None 
)

Definition at line 2476 of file timeline_webview.py.

◆ RazorSliceAtCursor()

def timeline_webview.TimelineWebView.RazorSliceAtCursor (   self,
  clip_id,
  trans_id,
  cursor_position 
)

Callback from javascript that the razor tool was clicked.

Definition at line 1644 of file timeline_webview.py.

◆ redraw_audio_onTimeout()

def timeline_webview.TimelineWebView.redraw_audio_onTimeout (   self)

Timer is ready to redraw audio (if any)

Definition at line 2815 of file timeline_webview.py.

◆ removeSelection()

def timeline_webview.TimelineWebView.removeSelection (   self,
  item_id,
  item_type 
)

Remove the selected clip from the selection.

Definition at line 2470 of file timeline_webview.py.

◆ render_cache_json()

def timeline_webview.TimelineWebView.render_cache_json (   self)

Render the cached frames to the timeline (called every X seconds), and only if changed.

Definition at line 2843 of file timeline_webview.py.

◆ resizeTimeline()

def timeline_webview.TimelineWebView.resizeTimeline (   self,
  new_duration 
)

Resize the duration of the timeline.

Definition at line 2658 of file timeline_webview.py.

◆ Reverse_Transition_Triggered()

def timeline_webview.TimelineWebView.Reverse_Transition_Triggered (   self,
  tran_ids 
)

Callback for reversing a transition.

Definition at line 2232 of file timeline_webview.py.

◆ Rotate_Triggered()

def timeline_webview.TimelineWebView.Rotate_Triggered (   self,
  action,
  clip_ids,
  position = "Start of Clip" 
)

Callback for rotate context menus.

Definition at line 1906 of file timeline_webview.py.

◆ round_to_multiple()

def timeline_webview.TimelineWebView.round_to_multiple (   self,
  number,
  multiple 
)

Round this to the closest multiple of a given #.

Definition at line 2154 of file timeline_webview.py.

◆ SelectAll()

def timeline_webview.TimelineWebView.SelectAll (   self)

Select all clips and transitions in JavaScript.

Definition at line 2835 of file timeline_webview.py.

◆ SetRazorMode()

def timeline_webview.TimelineWebView.SetRazorMode (   self,
  enable_razor 
)

Enable / Disable razor mode.

Definition at line 2454 of file timeline_webview.py.

◆ SetSnappingMode()

def timeline_webview.TimelineWebView.SetSnappingMode (   self,
  enable_snapping 
)

Enable / Disable snapping mode.

Definition at line 2446 of file timeline_webview.py.

◆ setup_js_data()

def timeline_webview.TimelineWebView.setup_js_data (   self)

Definition at line 2530 of file timeline_webview.py.

◆ show_all_clips()

def timeline_webview.TimelineWebView.show_all_clips (   self,
  clip,
  stretch = False 
)

Show all clips at the same time (arranged col by col, row by row)

Definition at line 2159 of file timeline_webview.py.

◆ Show_Waveform_Triggered()

def timeline_webview.TimelineWebView.Show_Waveform_Triggered (   self,
  clip_ids 
)

Show a waveform for the selected clip.

Definition at line 873 of file timeline_webview.py.

◆ ShowClipMenu()

def timeline_webview.TimelineWebView.ShowClipMenu (   self,
  clip_id = None 
)

Definition at line 481 of file timeline_webview.py.

◆ ShowEffectMenu()

def timeline_webview.TimelineWebView.ShowEffectMenu (   self,
  effect_id = None 
)

Definition at line 443 of file timeline_webview.py.

◆ ShowMarkerMenu()

def timeline_webview.TimelineWebView.ShowMarkerMenu (   self,
  marker_id = None 
)

Definition at line 2389 of file timeline_webview.py.

◆ ShowPlayheadMenu()

def timeline_webview.TimelineWebView.ShowPlayheadMenu (   self,
  position = None 
)

Definition at line 415 of file timeline_webview.py.

◆ ShowTimelineMenu()

def timeline_webview.TimelineWebView.ShowTimelineMenu (   self,
  position,
  layer_id 
)

Definition at line 459 of file timeline_webview.py.

◆ ShowTrackMenu()

def timeline_webview.TimelineWebView.ShowTrackMenu (   self,
  layer_id = None 
)

Definition at line 2367 of file timeline_webview.py.

◆ ShowTransitionMenu()

def timeline_webview.TimelineWebView.ShowTransitionMenu (   self,
  tran_id = None 
)

Definition at line 2258 of file timeline_webview.py.

◆ Slice_Triggered()

def timeline_webview.TimelineWebView.Slice_Triggered (   self,
  action,
  clip_ids,
  trans_ids,
  playhead_position = 0 
)

Callback for slice context menus.

Definition at line 1662 of file timeline_webview.py.

◆ Split_Audio_Triggered()

def timeline_webview.TimelineWebView.Split_Audio_Triggered (   self,
  action,
  clip_ids 
)

Callback for split audio context menus.

Definition at line 936 of file timeline_webview.py.

◆ Time_Triggered()

def timeline_webview.TimelineWebView.Time_Triggered (   self,
  action,
  clip_ids,
  speed = "1X",
  playhead_position = 0.0 
)

Callback for rotate context menus.

Definition at line 1952 of file timeline_webview.py.

◆ Transform_Triggered()

def timeline_webview.TimelineWebView.Transform_Triggered (   self,
  action,
  clip_ids 
)

Definition at line 860 of file timeline_webview.py.

◆ update_clip_data()

def timeline_webview.TimelineWebView.update_clip_data (   self,
  clip_json,
  only_basic_props = True,
  ignore_reader = False 
)

Create an updateAction and send it to the update manager.

Definition at line 207 of file timeline_webview.py.

◆ update_transition_data()

def timeline_webview.TimelineWebView.update_transition_data (   self,
  transition_json,
  only_basic_props = True 
)

Create an updateAction and send it to the update manager.

Definition at line 340 of file timeline_webview.py.

◆ update_zoom()

def timeline_webview.TimelineWebView.update_zoom (   self,
  newValue 
)

Definition at line 2480 of file timeline_webview.py.

◆ UpdateClipThumbnail()

def timeline_webview.TimelineWebView.UpdateClipThumbnail (   self,
  clip_data 
)

Update the thumbnail image for clips.

Definition at line 258 of file timeline_webview.py.

◆ Volume_Triggered()

def timeline_webview.TimelineWebView.Volume_Triggered (   self,
  action,
  clip_ids,
  position = "Entire Clip" 
)

Callback for volume context menus.

Definition at line 1806 of file timeline_webview.py.

◆ Waveform_Ready()

def timeline_webview.TimelineWebView.Waveform_Ready (   self,
  clip_id,
  audio_data 
)

Callback when audio waveform is ready.

Definition at line 921 of file timeline_webview.py.

◆ wheelEvent()

def timeline_webview.TimelineWebView.wheelEvent (   self,
  event 
)

Definition at line 2520 of file timeline_webview.py.

Member Data Documentation

◆ cache_renderer

timeline_webview.TimelineWebView.cache_renderer

Definition at line 2905 of file timeline_webview.py.

◆ cache_renderer_version

timeline_webview.TimelineWebView.cache_renderer_version

Definition at line 2856 of file timeline_webview.py.

◆ copy_clipboard

timeline_webview.TimelineWebView.copy_clipboard

Definition at line 1298 of file timeline_webview.py.

◆ copy_transition_clipboard

timeline_webview.TimelineWebView.copy_transition_clipboard

Definition at line 1299 of file timeline_webview.py.

◆ document_is_ready

timeline_webview.TimelineWebView.document_is_ready

Definition at line 169 of file timeline_webview.py.

◆ html_path

timeline_webview.TimelineWebView.html_path = os.path.join(info.PATH, 'timeline', 'index.html')
static

Definition at line 163 of file timeline_webview.py.

◆ item_id

timeline_webview.TimelineWebView.item_id

Definition at line 2648 of file timeline_webview.py.

◆ item_type

timeline_webview.TimelineWebView.item_type

Definition at line 2544 of file timeline_webview.py.

◆ last_position_frames

timeline_webview.TimelineWebView.last_position_frames

Definition at line 2429 of file timeline_webview.py.

◆ new_item

timeline_webview.TimelineWebView.new_item

Definition at line 2547 of file timeline_webview.py.

◆ redraw_audio_timer

timeline_webview.TimelineWebView.redraw_audio_timer

Definition at line 2899 of file timeline_webview.py.

◆ settings

timeline_webview.TimelineWebView.settings

Definition at line 2872 of file timeline_webview.py.

◆ window

timeline_webview.TimelineWebView.window

Definition at line 2866 of file timeline_webview.py.


The documentation for this class was generated from the following file: