GStreamer Editing Services 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:

GStreamer 편집 서비스

기술 문서 작성자:

Sidhartha10

프로젝트 이름:

GES 라이브러리의 문서 업데이트

프로젝트 길이:

표준 기간 (3개월)

Project description

Docs 시즌 프로그램에 참여하고 GStreamer Editing Services (GES) 조직에서 테크니컬 라이터로 일하고 싶습니다. GES팀에서 제안한 프로젝트를 검토한 결과 문서를 개선할 수 있다고 생각합니다. GES의 Alexandru Balut과 논의한 내용에 따라 다음 문서를 업데이트하고자 합니다 (우선순위가 높은 순서대로).

• GES 라이브러리의 개요를 업데이트하기 위해 이 페이지를 수정하겠습니다. 이 페이지에 언급된 대로 모든 클래스의 계층구조가 포함되도록 이 페이지가 업데이트됩니다. 이 페이지에는 GES 라이브러리를 구현하여 달성할 수 있는 모든 작업/기능에 관한 세부정보가 포함되어 있습니다. 예를 들어 GES 프로젝트, 타임라인, 레이어, 클립, 효과의 애셋 및 프록시 관리 이 페이지에는 최종 사용자가 기능을 더 잘 이해하는 데 도움이 되는 예시가 있습니다. 예를 들어 클립이 시작 부분에서 0도, 끝 부분에서 180도 회전되도록 클립에 효과를 적용하려면 어떻게 해야 하나요? 이 페이지는 모든 하위 페이지에 대한 교차 참조를 포함하도록 업데이트됩니다.
• 개별 클래스의 경우 UML 다이어그램을 만들어 해당 클래스와 관련 클래스 간의 관계를 보여줍니다.
• 오류 코드를 전송하는 다양한 동기 및 비동기 작업을 호출하겠습니다. 동기 작업은 불리언 (True=성공, False=오류)과 같은 반환 코드를 전송하는 반면 비동기 작업은 반환 코드를 전송하지 않습니다. 이 라이브러리의 신규 사용자는 오류 코드를 경험하게 되므로 오류 코드를 상세하게 문서화하는 것이 중요합니다.
• 현재 문서에는 구성원, 필드, 매개변수에 관한 정보가 누락된 사례가 여러 건 있습니다. 가상 메서드의 상수/클래스/매개변수 (및 가상 메서드 자체)에는 설명이 없습니다. 임시로 API에서 누락된 모든 격차를 식별하고 이를 수정합니다. 이 작업은 프로젝트 기간 동안 계속 진행됩니다.